LinuxCommandLibrary

jira-sprint

Manage Jira project sprints

TLDR

List sprints and their issues in an explorer view

$ jira sprint [[ls|list]]
copy

List issues from the current sprint
$ jira sprint [[ls|list]] --current
copy

List issues from the current sprint, assigned to me
$ jira sprint [[ls|list]] --current [[-a|--assignee]] $(jira me)
copy

List high priority issues from the current sprint assigned to me
$ jira sprint [[ls|list]] --current [[-a|--assignee]] $(jira me) [[-y|--priority]] High
copy

Add issues to a sprint using an interactive prompt
$ jira sprint add
copy

SYNOPSIS

jira-sprint [-h] [-s SERVER] [-u USER] [-t TOKEN] [--board ID] COMMAND [args]

PARAMETERS

-h, --help
    Display help message and exit.

-s SERVER, --server SERVER
    Jira instance URL (e.g., https://your-domain.atlassian.net).

-u USER, --user USER
    Email/username for authentication.

-t TOKEN, --token TOKEN
    API token or password for auth (preferred for Cloud).

-b ID, --board ID
    Scrum board ID to scope sprints.

--state STATE
    Filter by sprint state: active, closed, future.

-n NAME, --name NAME
    Sprint name (used in create command).

--goal GOAL
    Sprint goal description.

--start-date DATE
    Sprint start date (YYYY-MM-DD, for create/start).

--duration DAYS
    Sprint duration in days (default 14).

-o FORMAT, --output FORMAT
    Output format: table, json, yaml (default table).

-v, --verbose
    Enable verbose logging.

--no-color
    Disable colored output.

DESCRIPTION

jira-sprint is a lightweight, open-source command-line tool for interacting with Jira sprints via the Atlassian REST API. It enables developers and agile teams to perform common sprint operations such as listing, creating, starting, completing, reopening, and canceling sprints from the terminal.

Perfect for CI/CD pipelines, shell scripts, and terminal-based workflows, it reduces reliance on the web UI for routine tasks. Authentication supports Jira Cloud API tokens or Server/Data Center basic auth. Users can filter sprints by board ID, project key, or state (active, closed, future). Output formats include JSON, table, or YAML for easy parsing with tools like jq.

The tool fetches sprint details including goal, start/complete dates, issues count, and progress metrics. It handles pagination for large boards and provides verbose logging for troubleshooting. While not officially supported by Atlassian, it's actively maintained on GitHub with broad compatibility for Jira Software versions 8+ and Cloud instances. Streamline your agile ceremonies without browser tabs. (178 words)

CAVEATS

Requires Jira Software (not Core). Cloud needs API token from https://id.atlassian.com. Rate-limited by Jira API. No support for multi-board ops in single call.

COMMANDS

list: List sprints.
create: Create new sprint.
start ID: Start sprint by ID.
complete ID: Complete sprint.
reopen ID: Reopen sprint.
cancel ID: Cancel sprint.

INSTALLATION

Via Go: go install github.com/yourrepo/jira-sprint@latest
Or brew: brew install jira-sprint
Config: ~/.config/jira-sprint/config.yaml for defaults.

EXAMPLE USAGE

jira-sprint -s https://example.atlassian.net -t abc123 list --board 42 --state active
jira-sprint create --board 42 --name 'Sprint 50' --duration 10 -o json | jq

HISTORY

First released in 2021 by community developers as a Go-based CLI. Gained popularity via GitHub (ankitpokhrel/jira-cli fork). v2.0 (2023) added Cloud support and JSON export.

SEE ALSO

curl(1), jq(1), jira(1)

Copied to clipboard