summaryrefslogtreecommitdiff
path: root/docs/cli.markdown
blob: 7f923db002d6af5a82609518b96a902145003dec (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
Command Line Interface
======================

Kanboard provide a simple command line interface that can be used from any Unix terminal.

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
-----

- Open a terminal and go to your Kanboard directory (example: `cd /var/www/kanboard`)
- Run the command `./kanboard`

```bash
$ ./kanboard
Kanboard command line interface
===============================

- Task export to stdout (CSV format): ./kanboard export-csv <project_id> <start_date> <end_date>
```

Available commands
------------------

### CSV export of tasks

Usage:

```bash
./kanboard export-csv <project_id> <start_date> <end_date>
```

Example:

```bash
./kanboard export-csv 1 2014-07-14 2014-07-20 > /tmp/my_custom_export.csv
```