README.rst

Kanboard Command Line Client

Kanboard command line client.

• Author: Frédéric Guillot
• License: MIT

Installation

pip install kanboard_cli

This application is compatible with Python 2.7, Python 3.4 and 3.5.

Configuration

You can define connection parameters as environment variables:

export KANBOARD_URL=http://localhost/jsonrpc.php
export KANBOARD_USERNAME=admin
export KANBOARD_PASSWORD=admin

Or as command line arguments:

kanboard --url http://localhost/jsonrpc.php --username admin --password admin

Examples

Display application version:

> kanboard app version
1.0.35

Display project information:

> kanboard project show 1

+-------------+--------------------------------------------------------------------------------+
| Field       | Value                                                                          |
+-------------+--------------------------------------------------------------------------------+
| ID          | 1                                                                              |
| Name        | Demo Project                                                                   |
| Description | None                                                                           |
| Board URL   | http://localhost/?controller=BoardViewController&action=show&project_id=1      |
+-------------+--------------------------------------------------------------------------------+

Display projects list:

> kanboard project list

+----+------+--------------------------+--------+---------+--------+
| ID | Name | Description              | Status | Private | Public |
+----+------+--------------------------+--------+---------+--------+
| 7  | Demo | My _project_ is awesome. | Active | False   | True   |
| 8  | test |                          | Active | False   | False  |
+----+------+--------------------------+--------+---------+--------+