Skip to content

Latest commit

 

History

History
82 lines (58 loc) · 2.27 KB

README.md

File metadata and controls

82 lines (58 loc) · 2.27 KB
Raw

pivotal_tools

Geeky command-line interface with additional scrum, planning poker, and changelog generation features

Blog post on its usage

install

pip install pivotal_tools

setup

Add PIVOTAL_TOKEN to your environment

I put mine in ~/.zshenv, like so ...

export PIVOTAL_TOKEN='your token'

Also make sure in your pivotal project settings that you have "Allow API Access" checked (which is currently the default behavior)

usage

A collection of tools to help with your pivotal workflow

changelog

List out projects stories that are delivered or finished (not accepted)

show stories

Lists all stories for a given project (will prompt you if not specified) Can filter by user with the for option By default show the top 20 stories, can specify more (or less) with the number option

show story

Show the details for a given story. passing the project-index parameter will make it faster

open

Will open the given story in a browser. passing the project-index parameter will make it faster

scrum

Will list stories and bugs that team members are working on. Grouped by team member

poker (aka planning)

Help to facilitate a planning poker session

create (feature|bug|chore)

Create a story

CLI

  pivotal_tools create (feature|bug|chore) <title> [<description>] [--project-index=<pi>]
  pivotal_tools (start|finish|deliver|accept|reject) story <story_id> [--project-index=<pi>]
  pivotal_tools show stories [--project-index=<pi>] [--for=<user_name>] [--number=<number_of_stories>]
  pivotal_tools show story <story_id> [--project-index=<pi>]
  pivotal_tools open <story_id> [--project-index=<pi>]
  pivotal_tools changelog [--project-index=<pi>]
  pivotal_tools scrum [--project-index=<pi>]
  pivotal_tools (planning|poker) [--project-index=<pi>]

Options:
  -h --help             Show this screen.
  --for=<user_name>     Username, or initials
  --project-index=<pi>  If you have multiple projects, this is the index that the project shows up in my prompt
                        This is useful if you do not want to be prompted, and then you can pipe the output