jira-cards

A command line tool for generating scrum cards from jira. It allows you to customise the styling of the scrum cards using an erb template.

Installation

You are going to need to

Configuration

When you first run the tool it will ask you:

  • The url to your jira instance e.g. jira.atlassian.com
  • A username & password for accessing jira. Whatever user you use must be an admin
  • Path to the wkhtmltopdf e.g. C:\\Program Files\\wkhtmltopdf\\wkhtmltopdf.exe
  • If you want to use the default templates
    • If no, the path to the template erb & css file

These values are then written to a config.yml file. If you run the command it will tell you where the config file is if you want to change it.

Commands

The two commands are issues and iteration. For both commands you need to specify the output flag which is the path where you want the output pdf file to go to.

Issues

You want this command if you want to print specific issues. The only flag is —keys which are the key’s of the issues you want. e.g.


jira-cards issues --keys "foo-1, foo-4, foo-10" --output c:\temp\test.pdf

You can also specify ranges (a la ruby ranges) of keys e.g.


jira-cards issues --keys foo-4..foo-10 --output c:\temp\test.pdf

Iteration

You want this if you want to get all of the cards for an iteration (or version in jira-speak). The flags are:

  • —project
  • —version

jira-cards iteration --project "Some project" --version "Iteration 30" --output c:\temp\test.pdf

Templates

The scrum cards are generated from an erb html template which is then converted to pdf using pdfkit. If you want to use your own template you can specify the path to your erb template & css file in the initial config.