summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFrédéric Guillot <fred@kanboard.net>2014-11-29 14:20:59 -0500
committerFrédéric Guillot <fred@kanboard.net>2014-11-29 14:20:59 -0500
commitb97a4fedcc4729130817faf6637153106ad9b9f4 (patch)
tree528c749e8e2218cae78a5a0dd101ab18355ab9df /docs
parentd6bde1e3ec1d0b0fae7bb85e274e1bebb65d78db (diff)
Update cli doc
Diffstat (limited to 'docs')
-rw-r--r--docs/cli.markdown78
-rw-r--r--docs/email-configuration.markdown12
2 files changed, 68 insertions, 22 deletions
diff --git a/docs/cli.markdown b/docs/cli.markdown
index c7cb68f6..954b5299 100644
--- a/docs/cli.markdown
+++ b/docs/cli.markdown
@@ -14,41 +14,99 @@ Usage
```bash
$ ./kanboard
-Kanboard command line interface
-===============================
+Kanboard version master
-- Task export to stdout (CSV format): ./kanboard export-csv <project_id> <start_date> <end_date>
-- Send notifications for due tasks: ./kanboard send-notifications-due-tasks
+Usage:
+ [options] command [arguments]
+
+Options:
+ --help (-h) Display this help message.
+ --quiet (-q) Do not output any message.
+ --verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug.
+ --version (-V) Display this application version.
+ --ansi Force ANSI output.
+ --no-ansi Disable ANSI output.
+ --no-interaction (-n) Do not ask any interactive question.
+
+Available commands:
+ help Displays help for a command
+ list Lists commands
+export
+ export:daily-project-summary Daily project summary CSV export (number of tasks per column and per day)
+ export:tasks Tasks CSV export
+notification
+ notification:overdue-tasks Send notifications for overdue tasks
+projects
+ projects:daily-summary Calculate daily summary data for all projects
```
Available commands
------------------
-### CSV export of tasks
+### Tasks CSV export
Usage:
```bash
-./kanboard export-csv <project_id> <start_date> <end_date>
+./kanboard export:tasks <project_id> <start_date> <end_date>
```
Example:
```bash
-./kanboard export-csv 1 2014-07-14 2014-07-20 > /tmp/my_custom_export.csv
+./kanboard export:tasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv
```
-### Send notifications for due tasks
+CSV data are sent to stdout.
+
+### Send notifications for overdue tasks
Emails will be sent to all users with notifications enabled.
```bash
-./kanboard send-notifications-due-tasks
+./kanboard notification:overdue-tasks
+```
+
+You can also display the overdue tasks with the flag `--show`:
+
+```bash
+$ ./kanboard notification:overdue-tasks --show
++-----+---------+------------+------------+--------------+----------+
+| Id | Title | Due date | Project Id | Project name | Assignee |
++-----+---------+------------+------------+--------------+----------+
+| 201 | Test | 2014-10-26 | 1 | Project #0 | admin |
+| 202 | My task | 2014-10-28 | 1 | Project #0 | |
++-----+---------+------------+------------+--------------+----------+
```
Cronjob example:
```bash
# Everyday at 8am we check for due tasks
-0 8 * * * cd /path/to/kanboard && ./kanboard send-notifications-due-tasks >/dev/null 2>&1
+0 8 * * * cd /path/to/kanboard && ./kanboard notification:overdue-tasks >/dev/null 2>&1
+```
+
+### Run daily project summaries calculation
+
+You can add a background task that calculate the daily project summaries everyday:
+
+```bash
+$ ./kanboard projects:daily-summary
+Run calculation for Project #0
+Run calculation for Project #1
+Run calculation for Project #10
+```
+
+### Export daily summaries data in CSV
+
+The exported data will be printed on the standard output:
+
+```bash
+./kanboard export:daily-project-summary <project_id> <start_date> <end_date>
+```
+
+Example:
+
+```bash
+./kanboard export:daily-project-summary 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv
```
diff --git a/docs/email-configuration.markdown b/docs/email-configuration.markdown
index 614fe5da..8b2727b0 100644
--- a/docs/email-configuration.markdown
+++ b/docs/email-configuration.markdown
@@ -79,18 +79,6 @@ define('MAIL_FROM', 'notifications@kanboard.net');
That can be useful if your SMTP server configuration doesn't accept the default address.
-
-### Check for due tasks
-
-Every day, Kanboard can check for due tasks, to do that you have to setup a cronjob on your server and use the Kanboard command line interface.
-
-Here a example:
-
-```bash
-# Everyday at 8am we check for due tasks
-0 8 * * * cd /path/to/kanboard && ./kanboard send-notifications-due-tasks >/dev/null 2>&1
-```
-
### How to display a link to the task in notifications?
To do that, you have to specify the URL of your Kanboard installation in your [Application Settings](http://kanboard.net/documentation/application-configuration).