Skip to content

Releases: shortcut-cli/shortcut-cli

v4.0.0

13 Jan 14:18
acb2947

Choose a tag to compare

Highlights

This major release introduces full Iterations support, updates Commander with improved TypeScript types, and includes significant infrastructure improvements with the migration to pnpm.


New Commands

short iterations - List and Filter Iterations

List all iterations in your workspace with powerful filtering options.

short iterations [options]

Options:

Option Description
-S, --status [status] Filter by status (unstarted, started, done)
-T, --team [id|name] Filter by team/group id or name
-C, --current Show only current/active iterations
-t, --title [query] Filter iterations with name containing query
-d, --detailed Show more details for each iteration
-f, --format [template] Format each iteration output by template

Examples:

# List all iterations
short iterations

# Show current iterations only
short iterations -C

# Filter by status
short iterations -S started

# Filter by team
short iterations -T Engineering

short iteration - View, Create, Update, Delete Iterations

Full CRUD operations for individual iterations.

Subcommands:

Subcommand Description
view <id> View an iteration by id
create Create a new iteration
update <id> Update an existing iteration
delete <id> Delete an iteration
stories <id> List stories in an iteration

Create Options:

  • -n, --name [text] - Set name of iteration (required)
  • -d, --description [text] - Set description of iteration
  • --start-date [date] - Set start date in YYYY-MM-DD format (required)
  • --end-date [date] - Set end date in YYYY-MM-DD format (required)
  • -T, --team [id|name] - Set team/group of iteration
  • -I, --idonly - Print only ID of iteration result
  • -O, --open - Open iteration in browser

Update Options:

  • -n, --name [text] - Set name of iteration
  • -d, --description [text] - Set description of iteration
  • --start-date [date] - Set start date in YYYY-MM-DD format
  • --end-date [date] - Set end date in YYYY-MM-DD format
  • -T, --team [id|name] - Set team/group of iteration
  • -O, --open - Open iteration in browser

Stories Options:

  • -f, --format [template] - Format each story output by template

Examples:

# View an iteration
short iteration view 123

# Create a new iteration
short iteration create -n "Sprint 1" --start-date 2026-01-13 --end-date 2026-01-27 -T Engineering

# Update an iteration
short iteration update 123 -n "Sprint 1 - Extended" --end-date 2026-01-31

# Delete an iteration
short iteration delete 123

# List stories in an iteration
short iteration stories 123

Infrastructure Changes


Full Changelog: v3.8.1...v4.0.0

v3.8.1

12 Jan 16:10

Choose a tag to compare

Bug Fixes

Fix story comment creation

Fixed an issue where adding comments to stories via short story <id> --comment was failing. (by @charpeni in #360)

Root cause: The createStoryComment API expects an object with a text property ({ text: "comment" }), but the CLI was incorrectly passing a raw string.

Affected command:

short story 12345 --comment "My comment"

This command now works correctly again.

Full Changelog: v3.8.0...v3.8.1

v3.8.0

07 Jan 15:32

Choose a tag to compare

Highlights

This release introduces two major new command families - Epic Create and Docs - along with an updated Shortcut client library.


New Commands

short epic create - Create Epics from CLI (by @adamnbowen in #356)

Previously, the CLI could only list epics (short epics). Now you can create new epics directly from the command line.

short epic create [options]

Options:

Option Description
-n, --name [text] Epic name (required)
-d, --description [text] Epic description
-s, --state [name] Epic state (to do, in progress, done)
--deadline [date] Deadline date (YYYY-MM-DD format)
--planned-start [date] Planned start date (YYYY-MM-DD format)
-o, --owners [id|name] Comma-separated owner IDs or names
-T, --team [id|name] Comma-separated team IDs or names
-l, --label [id|name] Comma-separated label IDs or names
-M, --milestone [id] Milestone ID (deprecated)
-I, --idonly Print only the epic ID
-O, --open Open epic in browser after creation

Examples:

# Create a simple epic
short epic create -n "API Redesign Project"

# Create with description and state
short epic create -n "Q1 Platform Work" -d "Infrastructure improvements" -s "in progress"

# Create with deadline and owners
short epic create -n "Mobile Launch" --deadline 2024-06-30 -o alice,bob

# Create with team and labels
short epic create -n "Security Audit" -T Engineering -l security,compliance

# Create and open in browser
short epic create -n "Documentation Sprint" -O

short docs - List and Search Docs (by @charpeni in #359)

New command to list and search Shortcut Docs (alias: short d).

short docs [options]

Options:

Option Description
-t, --title [text] Search docs by title
--archived Show archived docs (requires --title)
--mine Show only your docs (requires --title)
--following Show docs you're following (requires --title)

Examples:

# List all docs
short docs

# Search docs by title
short docs -t "meeting notes"

short doc - View, Create, Update, and Delete Docs (by @charpeni in #359)

Full CRUD operations for individual Shortcut Docs.

Subcommands:

Subcommand Description
view <id> View a doc (also works as short doc <uuid>)
create Create a new doc
update <id> Update an existing doc
delete <id> Delete a doc (requires --confirm)

Create Options:

  • -t, --title [text] - Document title (required)
  • -c, --content [text] - Document content
  • --markdown - Parse content as Markdown

Update Options:

  • -t, --title [text] - New title
  • -c, --content [text] - New content
  • --markdown - Parse content as Markdown

Examples:

# View a doc
short doc view abc-123-uuid
short doc abc-123-uuid  # shorthand

# Create a doc with markdown
short doc create -t "My Doc" -c "# Hello" --markdown

# Update a doc
short doc update abc-123-uuid -t "New Title"

# Delete a doc
short doc delete abc-123-uuid --confirm

Dependencies

  • Updated @shortcut/client from 2.3.1 to 3.1.0 - Brings the latest Shortcut API improvements and fixes. (by @charpeni in #358)

Full Changelog: v3.7.0...v3.8.0

v3.7.0

20 Nov 16:22
182f4e8

Choose a tag to compare

What's Changed

New Contributors

Full Changelog: v3.6.0...v3.7.0

v3.6.0

21 Aug 18:41

Choose a tag to compare

Notable Changes

@akirayamamoto identified an issue (#343) where we were unable to use lookup by name for entities and resolved it in #344. Thank you!

What's Changed

New Contributors

Full Changelog: v3.5.0...v3.6.0

v3.5.0

16 Jul 18:23
99c63f8

Choose a tag to compare

What's Changed

New Contributors

Full Changelog: v3.4.0...v3.5.0

v3.4.0

11 Jun 19:46
3f229ba

Choose a tag to compare

What's Changed

  • @shortcut/client version has been updated
  • Updated axios to resolve a CVE
  • This CLI is now bundled via tsup rather than transpiled with tsc

Full Changelog: v3.3.0...v3.4.0