jira-sprints

View documentation for the original command

$ tldr jira sprint

jira-sprints [OPTIONS] COMMAND [ARGS]

-h, --help
    Show help message and exit

-v, --verbose
    Enable verbose output for debugging

-p PROJECT, --project PROJECT
    Specify Jira project key (default: current board project)

-b BOARD, --board BOARD
    Target specific board ID or name

--server URL
    Override configured Jira server URL

--token TOKEN
    Use inline API token for auth (insecure)

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

jira-sprints is a command-line interface tool designed to interact with Atlassian's Jira Software sprints directly from the Linux terminal. It allows developers and agile teams to list active sprints, start new ones, close completed sprints, and generate reports on sprint progress without needing to open a web browser.

Built on top of the Jira REST API, it requires authentication via API token or OAuth, typically configured through a ~/.jira/config.yml file specifying server URL, username, and token. The tool supports Scrum and Kanban boards, fetching sprint data for specified projects or boards.

Key features include filtering sprints by state (active, closed, future), displaying burndown charts in ASCII, and exporting metrics to JSON or CSV for integration with CI/CD pipelines or reporting tools. It's lightweight, dependency-free (uses standard libcurl and jq), and ideal for automation scripts in DevOps workflows.

Usage streamlines agile ceremonies: query sprint velocity, issues completed, and time tracking in seconds. However, rate limits apply per Jira instance, so heavy scripting should include delays.

Requires Jira Software (not Cloud-only free tier for all features); API token must have Browse projects and Manage sprints permissions.
Rate limited to ~100 calls/minute; no multi-threaded support. Config file must be set up first via jira-sprints setup.

Run jira-sprints setup to generate ~/.jira/config.yml with server, email, and token prompts.
Example:
server: https://your-domain.atlassian.net
user: user@example.com
token: your_api_token

list: List sprints.
start [--name NAME]: Start new sprint.
close [--id ID]: Close sprint.
report [--days DAYS]: Sprint burndown report.

Developed in 2022 as open-source by a DevOps community on GitHub (github.com/agiledev/jira-sprints-cli). Initial v1.0 supported list/close; v2.0 (2023) added reports and CSV export. Actively maintained with 500+ stars.

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