summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2017-06-18 21:57:20 -0400
committerFrederic Guillot <fred@kanboard.net>2017-06-18 21:57:20 -0400
commit94a86237fc3d8f554170113ab2b5bdcd12586740 (patch)
tree58472540dd7f6ba9bf5d4b6b09210383572949e5 /doc
parentba068aa1c4922879b230e8dad7c63da6b991e32f (diff)
Add command line argument to filter overdue notification for a given project
Diffstat (limited to 'doc')
-rw-r--r--doc/en_US/cli.markdown15
1 files changed, 14 insertions, 1 deletions
diff --git a/doc/en_US/cli.markdown b/doc/en_US/cli.markdown
index b1722308..b7d60705 100644
--- a/doc/en_US/cli.markdown
+++ b/doc/en_US/cli.markdown
@@ -133,11 +133,12 @@ Optional parameters:
- `--show`: Display notifications sent
- `--group`: Group all overdue tasks for one user (from all projects) in one email
- `--manager`: Send all overdue tasks to project manager(s) in one email
+- `-p|--project project_id|identifier`: Send notifications only for the given project
You can also display the overdue tasks with the flag `--show`:
```bash
-./kanboard notification:overdue-tasks --show
+./cli notification:overdue-tasks --show
+-----+---------+------------+------------+--------------+----------+
| Id | Title | Due date | Project Id | Project name | Assignee |
+-----+---------+------------+------------+--------------+----------+
@@ -146,6 +147,18 @@ You can also display the overdue tasks with the flag `--show`:
+-----+---------+------------+------------+--------------+----------+
```
+Example to filter by project:
+
+```bash
+./cli notification:overdue-tasks --project 123
+```
+
+Or if you have defined a project identifier:
+
+```bash
+./cli notification:overdue-tasks --project MY_PROJECT
+```
+
### Run daily project stats calculation
This command calculate the statistics of each project: