From 4ae655ced334bb48342274caaf15f2b3d8b444f6 Mon Sep 17 00:00:00 2001
From: Frédéric Guillot <fred@kanboard.net>
Date: Sun, 20 Jul 2014 08:34:35 -0230
Subject: Add CLI documentation

---
 docs/cli.markdown | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 docs/cli.markdown

(limited to 'docs')

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
+```
-- 
cgit v1.2.3