blob: 954b529945aa05d78c07542bc3eab8a106df80eb (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
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 process by example running a huge report.
Usage
-----
- Open a terminal and go to your Kanboard directory (example: `cd /var/www/kanboard`)
- Run the command `./kanboard`
```bash
$ ./kanboard
Kanboard version master
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
------------------
### Tasks CSV export
Usage:
```bash
./kanboard export:tasks <project_id> <start_date> <end_date>
```
Example:
```bash
./kanboard export:tasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv
```
CSV data are sent to stdout.
### Send notifications for overdue tasks
Emails will be sent to all users with notifications enabled.
```bash
./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 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
```
|
