summaryrefslogtreecommitdiff
path: root/docs/cli.markdown
diff options
context:
space:
mode:
authorFrédéric Guillot <fred@kanboard.net>2014-08-15 21:13:37 -0700
committerFrédéric Guillot <fred@kanboard.net>2014-08-15 21:13:37 -0700
commit498408d5075cf0060e0f53e58261e6537e0f6080 (patch)
tree46f187f95dfe70a54d601406c5eb68f94979960a /docs/cli.markdown
parent9eeded33f68872515954a2fc177fcb47a9273ae9 (diff)
Update documentation
Diffstat (limited to 'docs/cli.markdown')
-rw-r--r--docs/cli.markdown19
1 files changed, 17 insertions, 2 deletions
diff --git a/docs/cli.markdown b/docs/cli.markdown
index 7f923db0..4c4913e8 100644
--- a/docs/cli.markdown
+++ b/docs/cli.markdown
@@ -2,11 +2,10 @@ Command Line Interface
======================
Kanboard provide a simple command line interface that can be used from any Unix terminal.
+This tool can be used only on the local machine.
This feature is useful to run commands outside the web server by example a huge report.
-Actually there is only one command, more stuff will be added later.
-
Usage
-----
@@ -19,6 +18,7 @@ Kanboard command line interface
===============================
- 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
```
Available commands
@@ -37,3 +37,18 @@ Example:
```bash
./kanboard export-csv 1 2014-07-14 2014-07-20 > /tmp/my_custom_export.csv
```
+
+### Send notifications for due tasks
+
+Emails will be sent to all users with notifications enabled.
+
+```bash
+./kanboard send-notifications-due-tasks
+```
+
+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
+```