Permalink
Browse files

Adding doc to restructure commands

  • Loading branch information...
matheussbernardo committed Aug 6, 2018
1 parent fc56b6b commit 3747fc8db3fd377a45f73953bcab9f41636d6ecf
Showing with 77 additions and 91 deletions.
  1. +12 −12 README.md
  2. +65 −79 man/trollolo.1.md
@@ -77,7 +77,7 @@ board_aliases:
You can issue the command:
```
trollolo get-cards --board-id=MyTrelloBoard
trollolo get cards --board-id=MyTrelloBoard
```
## Creating burndown charts
@@ -96,21 +96,21 @@ The work flow goes as follows:
Start the workflow by using the current directory as working directory and
initialize it for the burndown chart generation:
trollolo burndown-init --board-id=MYBOARDID
trollolo burndown init --board-id=MYBOARDID
By default, trollolo uses the current directory as working directory, if you
want to specify another directory as working directory, use the `--output`
option as follows:
trollolo burndown-init --board-id=MYBOARDID --output=WORKING_DIR
trollolo burndown init --board-id=MYBOARDID --output=WORKING_DIR
This will create a directory WORKING_DIR and put an initial data file there,
which contains the meta data. The file is called `burndown-data-1.yaml`. You
might want to keep this file in a git repository for safe storage and history.
After each daily go to the working directory and call:
trollolo burndown
trollolo burndown update
This will get the current data from the Trello board and update the data file
with the data from the current day. If there already was some data in the file
@@ -119,15 +119,15 @@ for the same day it will be overridden.
When the sprint is over and you want to start with the next sprint, go to the
working directory and call:
trollolo burndown --new-sprint
trollolo burndown update --new-sprint
This will create a new data file for the next sprint number and populate it
with initial data taken from the Trello board. You are ready to go for the
sprint now and can continue with calling `trollolo burndown` after each daily.
To push the current state of the scrum process (current day) to an api endpoint call:
trollolo burndown --push-to-api URL
trollolo burndown update --push-to-api URL
Trollolo will send a json encoded POST request to `URL` with the same structure as the generated burndown yaml file.
@@ -141,11 +141,11 @@ The specified `URL` can contain placeholders which will be replaced:
To generate the actual burndown chart, go to the working directory and call:
trollolo plot SPRINT_NUMBER
trollolo burndown plot SPRINT_NUMBER
or fetch and plot data in one step with:
trollolo burndown --plot
trollolo burndown update --plot
This will take the data from the file `burndown-data-SPRINT_NUMBER.yaml` and
create a nice chart from it. It will show the chart and also create a file
@@ -249,15 +249,15 @@ Since several boards can share the same name, they are only used when creating t
Create the boards and lists:
trollolo setup-scrum
trollolo scrum init
Lookup the ID of the created boards and use them as arguments:
# https://trello.com/b/123abC/sprint-board
# https://trello.com/b/GHi456/planning-board
trollolo cleanup-sprint --board-id=123abC --target-board-id=GHi456
trollolo set-priorities --board-id=GHi456
trollolo move-backlog --planning-board-id=GHi456 --sprint-board-id=123abC
trollolo scrum end --board-id=123abC --target-board-id=GHi456
trollolo scrum prioritize --board-id=GHi456
trollolo scrum start --planning-board-id=GHi456 --sprint-board-id=123abC
You can use aliases, as described in the configuration section, instead of IDs.
@@ -43,195 +43,181 @@ and cards and has functionality for extracting data for burndown charts.
Displays help about the available trollolo commands. Can take a command as
an argument to display detailed information about it.
### burndown-init -- Initialize burndown chart
### burndown init -- Initialize burndown chart
`trollolo burndown-init --board-id=<board id> --output=<directory>`
`trollolo burndown init --board-id=<board id> --output=<directory>`
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 `burndown` command can be used to update the file with
burndown charts. The `burndown update` command can be used to update the file with
data from the specified Trello board.
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.
### burndown -- Process data for burndown chart
### burndown update -- Process data for burndown chart
`trollolo burndown --output=<directory>`
`trollolo burndown update --output=<directory>`
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 `burndown` command by running the
`burndown-init` command.
initialized before running the `burndown update` command by running the
`burndown init` command.
The actual generation of the burndown chart is done by running the script
which is put into the directory by the `burndown-init` command.
which is put into the directory by the `burndown init` command.
For correct generation of the burndown chart, the Trello board has to follow
a few convention. They are described in the section `CONVENTIONS for SCRUM
BOARDS`.
### burndowns -- Process data for multiple burndown charts at once
### burndown multi-update -- Process data for multiple burndown charts at once
`trollolo burndowns --board-list=<board list>`
`trollolo burndown multi-update --board-list=<board list>`
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.
### plot -- Plot burndown chart
### burndown plot -- Plot burndown chart
`trollolo plot <sprint-number>`
`trollolo burndown plot <sprint-number>`
Plot the burndown chart for given sprint. This command assumes that you are in
the burndown directory (initially created with `burndown-init`) and that the
the burndown directory (initially created with `burndown init`) and that the
corresponding file `burndown-data-<sprint-number>.yaml` exists there.
### fetch-burndown-data -- Read data for burndown chart
### get boards -- Get boards for a member
`trollolo fetch-burndown-data --board-id=<board id>`
`trollolo get boards --member-id=<member id>`
Reads data from the specified Trello board, extracts it according to the
conventions for Scrum boards, and reports burndown data.
Get a list of all boards the given user is a member of.
### get-cards -- Get card data for a board
### get cards -- Get card data for a board
`trollolo get-cards --board-id=<boad id>`
`trollolo get cards --board-id=<board id>`
Read all card data for a given board.
### get-checklists -- Get checklist data for a board
### get checklists -- Get checklist data for a board
`trollolo get-checklists --board-id=<boad id>`
`trollolo get checklists --board-id=<board id>`
Read all checklist data for a given board
### get-description -- Get description of a card
### get description -- Get description of a card
`trollolo get-description --card-id=<card id>`
`trollolo get description --card-id=<card id>`
Read description of a given card.
### get-lists -- Get list data for a board
### get lists -- Get list data for a board
`trollolo get-lists --board-id=<boad id>`
`trollolo get lists --board-id=<board id>`
Read all list data for a given board.
### get-raw -- Get raw JSON from Trello API
### get members -- Get organization members
`trollolo get-raw <url fragment>`
`trollolo get members --org-name=<org name>`
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.
Read all members data for a given organization.
### backup -- Create local copy of a board
### get organization -- Get organization data
`trollolo backup --board-id=<board id>`
`trollolo get organization --org-name=<org name>`
Save a local copy of a board as a JSON file. The backup will be stored in
'~/.trollolo/backup/<board-id>/'.
Read organization info.
### list-backups -- List all backups
### get url -- Get raw JSON from Trello API
`trollolo list-backups`
`trollolo get url <url fragment>`
Get a list of all local backups.
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.
### show-backup -- Show local backup
### backup create -- Create local copy of a board
`trollolo show-backup --board-id=<board id>`
`trollolo backup create --board-id=<board id>`
Show the local backup of the given board.
Save a local copy of a board as a JSON file. The backup will be stored in
'~/.trollolo/backup/<board-id>/'.
### list-member-boards -- List name and id of boards for a user
### backup list -- List all backups
`trollolo list-member-boards --member-id=<member id>`
`trollolo backup list`
Get a list of all boards the given user is a member of.
Get a list of all local backups.
### set-cover -- Set picture as cover
### backup show -- Show local backup
`trollolo set-cover <filename> --card-id=<card id>`
`trollolo backup show --board-id=<board id>`
Use the given file as the cover for the given card.
Show the local backup of the given board.
### make-cover -- Make existing picture the cover
### set cover -- Set picture as cover
`trollolo make-cover <filename> --card-id=<card id>`
`trollolo set cover <filename> --card-id=<card id>`
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
`set-cover`.
### organization -- Get organization details
`trollolo organization --org-name=<organization name>`
Get details of an organization.
### organization-members -- Get a list of organization member
`trollolo organization-members --org-name=<organization name>`
be an attachment of the given card.
Get a list of all organization members.
### set description -- Write description to a card
### set-description -- Write description to a card
`trollolo set-description --card-id=<card id>`
`trollolo set description --card-id=<card id>`
Write description to the given card. The description is read from STDIN, use
<^D> to end input.
### setup-scrum -- Setup Scrum boards
### scrum init -- Setup Scrum boards
`trollolo setup-scrum`
`trollolo scrum init`
Create boards, lists and labels with names configured in '~/.trollolorc' or
with the defaults.
### move-backlog -- Move backlog from planning to sprint board
### scrum start -- Move backlog from planning to sprint board
`trollolo move-backlog --planning-board-id=<planning board id>
`trollolo scrum start --planning-board-id=<planning board id>
--sprint-board-id=<sprint board id>`
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.
### cleanup-sprint -- Move cards back to planning board
### scrum end -- Move cards back to planning board
`trollolo cleanup-sprint --board-id=<board id> --target-board-id=<target board
`trollolo scrum end --board-id=<board id> --target-board-id=<target board
id>`
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.
### set-priorities -- Add priorities to card titles
### scrum prioritize -- Add priorities to card titles
`trollolo set-priorities --board-id=<board id>`
`trollolo scrum prioritize --board-id=<board id>`
Add 'P<n>: ' 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.
### scrum backlog -- Show planning backlog of board
## EXAMPLES
`trollolo scrum backlog --board-id=<board id>`
Shows planning backlog for a given board.
Fetch burndown data of a Trello board configured in the configuration file:
`trollolo fetch-burndown-data --board-id=CRdddpdy`
## EXAMPLES
Fetch raw data of all cards of a Trello board:
`trollolo get-cards --raw --board-id=CRdddpdy`
`trollolo get cards --raw --board-id=CRdddpdy`
Fetch raw JSON of a list:
`trollolo get-raw lists/53186e8391ef8671265eba9f/cards?filter=open`
`trollolo get url lists/53186e8391ef8671265eba9f/cards?filter=open`
## CONFIGURATION
@@ -273,7 +259,7 @@ board_aliases:
You can issue the command:
```
trollolo get-cards --board-id=MyTrelloBoard
trollolo get cards --board-id=MyTrelloBoard
```

0 comments on commit 3747fc8

Please sign in to comment.