walter

Walter

That rug really tied the room together, did it not?

CLI application for getting information out of Jira. It's based on Donny so the aims are the same:

CLI application for retrieving data from Jira

Usage:
  walter [command]

Available Commands:
  board       Board related commands
  help        Help about any command
  sprint      Sprint related commands

Flags:
      --config string   config file (default is $HOME/.walter/config.yaml)
  -h, --help            help for walter
  -t, --toggle          Help message for toggle

Use "walter [command] --help" for more information about a command.

Requirements

If you are wanting to build and develop this, you will need the following items installed. If, however, you just want to run the application I recommend using the docker container (See below)

• Go version 1.11+

Configuration

Environment variables

You will need the following environment variables defining:

export JIRA_TOKEN=""
export JIRA_URL=""
export JIRA_USERNAME=""

Creating a Jira API Token is documented here

Application configuration file

Long term this may not be required, but right now we need a configuration file (by default, ~/.walter/config.yaml)

An example:

boards:
  My special board:
    story_point_field: customfield_888
    layout:
      - To Do
      - In Progress
      - Stuck
      - Review
      - Done

• boards - This is the top level node for board configuration
• My special board - This is the name of the board (walter board list)
• story_point_field - This defins the custom field that is houses the story point estimation (If you do not define this, the sprint.burndown command does not fully render all the information)
• layout - This is the names of the columns on the board (I am struggling to find an API endpoint that documents this)

Installation via Docker

Other than requiring docker to be installed, there are no other requirements to run the application this way. This is the preferred method of running the walter. The image is here.

$ docker run \
    --rm \
    -t \
    -eJIRA_TOKEN \
    -eJIRA_URL \
    -eJIRA_USERNAME \
    -v "${HOME}/.walter":/root/.walter \
    benmatselby/walter "$@"

Installation via Git

git clone [email protected]:benmatselby/walter.git
cd walter
make all
./walter