Skip to content

christian-fei/trello-recap

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

93 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

travis npm-version npm-dependencies standard-js npm-license Greenkeeper badge

trello-recap

npm i -g trello-recap

configuration

Get an API Key and Token from Trello.

Set the following environment variables:

TRELLO_API_KEY
TRELLO_API_TOKEN

Get the keys from here: https://trello.com/app-key

usage

--board is needed.

Tip: You can also pass it as first argument: trello-recap "TRELLO_BOARD_NAME" --since "2018-02-01"

--since is optional, ISO Date formatted string. e.g. 2018-02-01

--member is optional, username of a member (e.g. christianfei)

--list is optional, filter lists by name (e.g. done)

--label is optional, filter cards by label (e.g. bug)

--effort is optional, if yes or y will calculate effort by label

# set env variables
TRELLO_API_KEY=<YOUR_TRELLO_API_KEY>
TRELLO_API_TOKEN=<YOUR_TRELLO_API_TOKEN>

trello-recap --board "TRELLO_BOARD_NAME" --since "2018-02-01"

or with npx

npx trello-recap --board "TRELLO_BOARD_NAME"  --since "2018-02-01"

options

--board

Specify the name of the board.

Tip: put it between "" when passing it to the cli

--since

Filter cards after that date

--member

Filter cards assigned to a member

--list

Filter lists by name

--label

Filter lists by label

--effort

Calculates efforts by label