.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "TROLLOLO" "1" "June 2014" "" ""
.
.SH "NAME"
\fBTrollolo\fR \- Trello command line client
.
.SH "SYNOPSIS"
\fBtrollolo\fR [command] [options]
.
.P
\fBtrollolo\fR help [command]
.
.SH "DESCRIPTION"
\fBTrollolo\fR is a command line client for Trello\. It supports fetching lists and cards and has functionality for extracting data for burndown charts\.
.
.SH "GENERAL OPTIONS"
.
.TP
\fB\-\-version\fR
Give out version of trollolo tool\. Exit when done\.
.
.TP
\fB\-\-verbose\fR
Run in verbose mode\.
.
.TP
\fB\-\-board\-id\fR
Most commands take a \fBboard\-id\fR parameter\. This is the id of the Trello board\. It is the cryptic part of the URL of the Trello board\.
.
.TP
\fB\-\-raw\fR
Some of the commands take a \fBraw\fR option\. If this is provided the commands put out the raw JSON returned by the server instead of processing it to a more human\-readable version\.
.
.SH "COMMANDS"
.
.SS "burndown\-init \-\- Initialize burndown chart"
\fBtrollolo burndown\-init \-\-board\-id=<board id> \-\-output=<directory>\fR
.
.P
Initialize the given directory for the generation of burndown charts\. It stores the given board id in the directory in a YAML file together with other configuration data\. The YAML file also is used to store the data for the burndown charts\. The \fBburndown\fR command can be used to update the file with data from the specified Trello board\.
.
.P
The directory also gets a script to do the actual generation of the burndown chart\. Just run this script after each update of the data to get the latest burndown chart\.
.
.SS "burndown \-\- Process data for burndown chart"
\fBtrollolo burndown \-\-output=<directory>\fR
.
.P
Update the burndown data in the given directory from the Trello board specified in the YAML file in the directory\. The given directory has to be initialized before running the \fBburndown\fR command by running the \fBburndown\-init\fR command\.
.
.P
The actual generation of the burndown chart is done by running the script which is put into the directory by the \fBburndown\-init\fR command\.
.
.P
For correct generation of the burndown chart, the Trello board has to follow a few convention\. They are described in the section \fBCONVENTIONS for SCRUM BOARDS\fR\.
.
.SS "fetch\-burndown\-data \-\- Read data for burndown chart"
\fBtrollolo fetch\-burndown\-data \-\-board\-id=<board id>\fR
.
.P
Reads data from the specified Trello board, extracts it according to the conventions for Scrum boards, and reports burndown data\.
.
.SS "get\-cards \-\- Get card data for a board"
Read all card data for a given board\.
.
.SS "get\-checklists \-\- Get checklist data for a board"
Read all checklist data for a given board
.
.SS "get\-lists \-\- Get list data for a board"
Read all list data for a given board\.
.
.SH "EXAMPLES"
Fetch burndown data of a Trello board configured in the configuration file:
.
.P
\fBtrollolo fetch\-burndown\-data \-\-board\-id=CRdddpdy\fR
.
.P
Fetch raw data of all cards of a Trello board:
.
.P
\fBtrollolo get\-cards \-\-raw \-\-board\-id=CRdddpdy\fR
.
.SH "CONFIGURATION"
Trollolo reads a configuration file \fB\.trollolorc\fR in the home directory of the user running the command line tool\. It reads the data required to authenticate with the Trello server from it\. It\'s two values (the example shows random data):
.
.IP "" 4
.
.nf

developer_public_key: 87349873487ef8732487234
member_token: 87345897238957a29835789b2374580927f3589072398579820345
.
.fi
.
.IP "" 0
.
.P
These values have to be set with the personal access data for the Trello API and the id of the board, which is processed\.
.
.P
For creating a developer key go to the Developer API Keys \fIhttps://trello\.com/1/appKey/generate\fR page on Trello\. It\'s the key in the first box\.
.
.P
For creating a member token go follow the instructions \fIhttps://trello\.com/docs/gettingstarted/index\.html#getting\-a\-token\-from\-a\-user\fR in the Trello API documentation\.
.
.P
The board id is the cryptic string in the URL of your board\.
.
.SH "CONVENTIONS FOR SCRUM BOARDS"
The burndown functionality expects the board to follow a certain naming scheme, so that Trollolo can process it as a Scrum board\.
.
.P
It expects a list \fBSprint Backlog\fR with open items, a list \fBDoing\fR with items in progress, and a list \fBDone Sprint X\fR with done items, where \fBX\fR is the number of the sprint\. For burndown data calculation the list with the highest number is taken\.
.
.P
On work item cards the tool takes a bracketed number as suffix as size of the item in story points\. E\.g\. a card with the title \fB(3) Build magic tool\fR would have three story points\.
.
.P
Cards under the waterline not part of the actual sprint commitment are expected to have a label with the name "Under waterline"\.
.
.P
An example for a board which follow this conventions is the Trollolo Testing Board \fIhttps://trello\.com/b/CRdddpdy/trollolo\-testing\-board\fR\.
.
.SH "COPYRIGHT"
Trollolo is Copyright (C) 2013\-2014 SUSE LLC