diff options
| -rw-r--r-- | README.markdown | 18 | ||||
| -rw-r--r-- | docs/cli.markdown | 39 | ||||
| -rwxr-xr-x | kanboard | 2 |
3 files changed, 47 insertions, 12 deletions
diff --git a/README.markdown b/README.markdown index c2d920f5..fb32eb47 100644 --- a/README.markdown +++ b/README.markdown @@ -20,9 +20,9 @@ Features -------- - Multiple boards/projects -- Boards customization, rename or add columns +- Boards customization, rename/add/remove columns - Tasks with different colors, categories, sub-tasks, attachments, Markdown support for the description -- Automatic actions +- Automatic actions based on events - Users management with a basic privileges separation (administrator or regular user) - External authentication: Google and GitHub accounts as well as LDAP/ActiveDirectory - Webhooks to create tasks from an external software @@ -31,13 +31,8 @@ Features - **Super easy setup**, copy and paste files and you are done! - Translations in English, French, Brazilian Portuguese, Spanish, German, Polish, Swedish and Chinese -Roadmap -------- - -Kanboard is under active development, have a look to the roadmap: <http://kanboard.net/#roadmap> - -Known bugs ----------- +Known bugs and feature requests +------------------------------- See Issues: <https://github.com/fguillot/kanboard/issues> @@ -109,11 +104,12 @@ Documentation - [Google authentication](docs/google-authentication.markdown) - [GitHub authentication](docs/github-authentication.markdown) -#### Developers +#### Developers and sysadmins +- [Command line interface](docs/cli.markdown) - [Json-RPC API](docs/api-json-rpc.markdown) -- [How to use Kanboard with Vagrant](docs/vagrant.markdown) - [Webhooks](docs/webhooks.markdown) +- [How to use Kanboard with Vagrant](docs/vagrant.markdown) The documentation is written in [Markdown](http://en.wikipedia.org/wiki/Markdown). If you want to improve the documentation, just send a pull-request. 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 +``` @@ -23,7 +23,7 @@ $cli = new Cli; // Usage $cli->register('help', function() { - echo 'Kanboard command line interface'.PHP_EOL.'==============================='.PHP_EOL; + echo 'Kanboard command line interface'.PHP_EOL.'==============================='.PHP_EOL.PHP_EOL; echo '- Task export to stdout (CSV format): '.$GLOBALS['argv'][0].' export-csv <project_id> <start_date> <end_date>'.PHP_EOL; }); |