.\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . .TH "TROLLOLO" "1" "February 2018" "" "" . .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\. Since the actual id is hard to remember, you can set an alias in the \fB\.trollolorc\fR file and use that instead of the actual id\. See \fICONFIGURATION\fR section below\. . .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 "help \-\- Display help" \fBtrollolo help [COMMAND]\fR . .P Displays help about the available trollolo commands\. Can take a command as an argument to display detailed information about it\. . .SS "burndown\-init \-\- Initialize burndown chart" \fBtrollolo burndown\-init \-\-board\-id= \-\-output=\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=\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 "burndowns \-\- Process data for multiple burndown charts at once" \fBtrollolo burndowns \-\-board\-list=\fR . .P Updates the burndown data for all boards specified in the YAML file in the given directory\. See the previous section for details on the update process\. . .SS "plot \-\- Plot burndown chart" \fBtrollolo plot \fR . .P Plot the burndown chart for given sprint\. This command assumes that you are in the burndown directory (initially created with \fBburndown\-init\fR) and that the corresponding file \fBburndown\-data\-\.yaml\fR exists there\. . .SS "fetch\-burndown\-data \-\- Read data for burndown chart" \fBtrollolo fetch\-burndown\-data \-\-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" \fBtrollolo get\-cards \-\-board\-id=\fR . .P Read all card data for a given board\. . .SS "get\-checklists \-\- Get checklist data for a board" \fBtrollolo get\-checklists \-\-board\-id=\fR . .P Read all checklist data for a given board . .SS "get\-description \-\- Get description of a card" \fBtrollolo get\-description \-\-card\-id=\fR . .P Read description of a given card\. . .SS "get\-lists \-\- Get list data for a board" \fBtrollolo get\-lists \-\-board\-id=\fR . .P Read all list data for a given board\. . .SS "get\-raw \-\- Get raw JSON from Trello API" \fBtrollolo get\-raw \fR . .P Read raw JSON from Trello using the given URL fragment\. Trollolo adds the server part and API version as well as the credentials from the Trollolo configuration\. . .SS "backup \-\- Create local copy of a board" \fBtrollolo backup \-\-board\-id=\fR . .P Save a local copy of a board as a JSON file\. The backup will be stored in \'~/\.trollolo/backup/\fIboard\-id\fR/\'\. . .SS "list\-backups \-\- List all backups" \fBtrollolo list\-backups\fR . .P Get a list of all local backups\. . .SS "show\-backup \-\- Show local backup" \fBtrollolo show\-backup \-\-board\-id=\fR . .P Show the local backup of the given board\. . .SS "list\-member\-boards \-\- List name and id of boards for a user" \fBtrollolo list\-member\-boards \-\-member\-id=\fR . .P Get a list of all boards the given user is a member of\. . .SS "set\-cover \-\- Set picture as cover" \fBtrollolo set\-cover \-\-card\-id=\fR . .P Use the given file as the cover for the given card\. . .SS "make\-cover \-\- Make existing picture the cover" \fBtrollolo make\-cover \-\-card\-id=\fR . .P Make the given picture the cover for the given card\. The given card must be an attachment of the given card\. If you want to use a new picture use \fBset\-cover\fR\. . .SS "organization \-\- Get organization details" \fBtrollolo organization \-\-org\-name=\fR . .P Get details of an organization\. . .SS "organization\-members \-\- Get a list of organization member" \fBtrollolo organization\-members \-\-org\-name=\fR . .P Get a list of all organization members\. . .SS "set\-description \-\- Write description to a card" \fBtrollolo set\-description \-\-card\-id=\fR . .P Write description to the given card\. The description is read from STDIN, use \fI^D\fR to end input\. . .SS "setup\-scrum \-\- Setup Scrum boards" \fBtrollolo setup\-scrum\fR . .P Create boards, lists and labels with names configured in \'~/\.trollolorc\' or with the defaults\. . .SS "move\-backlog \-\- Move backlog from planning to sprint board" \fBtrollolo move\-backlog \-\-planning\-board\-id= \-\-sprint\-board\-id=\fR . .P Move cards from the \'Backlog\' list on the planning board to the \'Sprint Backlog\' list on the sprint board\. This is generally done after the planning meeting in preparation for a sprint\. . .SS "cleanup\-sprint \-\- Move cards back to planning board" \fBtrollolo cleanup\-sprint \-\-board\-id= \-\-target\-board\-id=\fR . .P Move unfinished cards from \'Sprint Backlog\', \'Doing\' and \'QA\' lists on the sprint board to the \'Ready\' list on the planning board\. This is generally done after the sprint is finished\. . .SS "set\-priorities \-\- Add priorities to card titles" \fBtrollolo set\-priorities \-\-board\-id=\fR . .P Add \'P\fIn\fR: \' to the beginning of every cards title in the \'Backlog\' list, replacing old values if present\. \'n\' is the current position of the card in the list\. . .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 . .P Fetch raw JSON of a list: . .P \fBtrollolo get\-raw lists/53186e8391ef8671265eba9f/cards?filter=open\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\. . .P The \fB\.trollolorc\fR file can also be used to set aliases for board ids\. When set, you will be able to use the alias instead of the board\-id in the various commands\. E\.g\. . .P With the following configuration . .IP "" 4 . .nf board_aliases: MyTrelloBoard: 53186e8391ef8671265ebf9e . .fi . .IP "" 0 . .P You can issue the command: . .IP "" 4 . .nf trollolo get\-cards \-\-board\-id=MyTrelloBoard . .fi . .IP "" 0 . .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 with a name starting with \fBDone\fR\. If there are multiple lists starting with \fBDone\fR the first one is taken\. . .P Other names of columns with work in progress can be set in the YAML file in the \fBmeta\fR section as an array of column names under the key \fBnot_done_columns\fR\. . .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\-2015 SUSE LLC