johnnycurran / exshortcut

CLI tool for interacting with Shortcut Project Management Tool. Written in Elixir

Shortcut CLI

Install

git clone [email protected]:JohnnyCurran/ExShortcut.git
cd ExShortcut
sudo ln -s `echo $PWD/shortcut` /usr/local/bin/shortcut
shortcut

Usage

Obtain your Shortcut token from https://app.shortcut.com/settings/account/api-tokens Set SHORTCUT_TOKEN as an env var:

export SHORTCUT_TOKEN=my_shortcut_token

(optional) If you'd like to default search (stories, epics) to a certain project, set SHORTCUT_PROJECT_NAME:

export SHORTCUT_PROJECT_NAME=my_project

(optional) If you know the project ID you want to work on, set SHORTCUT_PROJECT_ID

export SHORTCUT_PROJECT_ID=my_project_id

If you don't know your project ID, simply run:

shortcut projects

For a pretty-printed version (requires jq):

shortcut projects | jq '.[] | {name: .name, id: .id}'

shortcut  - commandline Shortcut API Integration
          - Operates on current story by default
          - Obtains current story ID from current git branch name
Usage:
new title [description]         Create new story with title and optional description
projects                        List all projects. Use with jq for pretty output, i.e. shorcut projects | jq '.[] | {name: .name, id: .id}'
whoami                          List info of the authenticated shortcut member from SHORTCUT_TOKEN
labels                          List labels and their attributes
label labelName                 Applies label 'labelName' to story from current branch
label storyId labelName         Applies label 'labelName' to story with id 'storyId'
storyid                         Returns the Story ID of the current branch you are working on
stories state                   Return stories with state 'state'. If SHORTCUT_PROJECT_NAME is set, only stories from that project will be returned
                                  Example: shortcut stories 'merged' | jq '.stories.data | .[] | .app_url'

Examples

Create Story

shortcut new 'my story' 'my description'

View all labels

shortcut labels

Set a label on a story

shortcut label 12345 bugfix

Github integration

If you use the suggested shortcut branch names for github integration, Shortcut will automatically read the story ID from the current branch name.

For example, to label your current story with bugfix, simply:

shortcut label bugfix