diff options
author | Frédéric Guillot <fred@kanboard.net> | 2014-07-20 08:34:35 -0230 |
---|---|---|
committer | Frédéric Guillot <fred@kanboard.net> | 2014-07-20 08:34:35 -0230 |
commit | 4ae655ced334bb48342274caaf15f2b3d8b444f6 (patch) | |
tree | 65fe9dd0d0729e9e64f487190ac9eaba21b09e96 /docs | |
parent | 833bd3f8a90b604f4ab289dab9366c0032ce5216 (diff) |
Add CLI documentation
Diffstat (limited to 'docs')
-rw-r--r-- | docs/cli.markdown | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/cli.markdown b/docs/cli.markdown new file mode 100644 index 00000000..7f923db0 --- /dev/null +++ b/docs/cli.markdown @@ -0,0 +1,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 +``` |