Skip to content
Simply SF logoSimply SF logoSimply CLI

Jira — Boards and sprints

simply atlassian jira board list

Section titled “simply atlassian jira board list”

List Jira agile boards.

Flags

  • --project <value> — Filter by project key or id.
  • --type <value> — Filter by board type: scrum or kanban.
  • --limit <value> — Maximum number of boards to return. (default: 50)

Connection

  • -e, --env-file <value> — Path to a .env file holding connection settings.
  • --jira-url <value> — Base URL of the Jira instance. (env: JIRA_URL)
  • --jira-username <value> — Account email for Jira Cloud basic auth. (env: JIRA_USERNAME)
  • --jira-api-token <value> — API token for Jira Cloud basic auth. (env: JIRA_API_TOKEN)
  • --jira-personal-token <value> — Personal access token for Jira Server/Data Center. (env: JIRA_PERSONAL_TOKEN)

Global

  • --json — the raw API payload, for scripts and agents.

Lists boards visible to the current Jira user. Use —project to restrict boards by project key or id, and —json for the complete paginated response.

Examples

Terminal window
simply atlassian jira board list
Terminal window
simply atlassian jira board list --project PROJ --type scrum
Terminal window
simply atlassian jira board list --limit 10 --json

simply atlassian jira sprint add

Section titled “simply atlassian jira sprint add”

Add existing issues to a sprint.

Flags

  • --dry-run — Print the request that would be sent and exit without sending it.

Connection

  • -e, --env-file <value> — Path to a .env file holding connection settings.
  • --jira-url <value> — Base URL of the Jira instance. (env: JIRA_URL)
  • --jira-username <value> — Account email for Jira Cloud basic auth. (env: JIRA_USERNAME)
  • --jira-api-token <value> — API token for Jira Cloud basic auth. (env: JIRA_API_TOKEN)
  • --jira-personal-token <value> — Personal access token for Jira Server/Data Center. (env: JIRA_PERSONAL_TOKEN)

Global

  • --json — the raw API payload, for scripts and agents.

Moves one or more existing issues into a numeric sprint. Jira accepts at most 50 issue keys per request, so larger lists are sent in chunks. Use —dry-run to inspect the payload without sending it; adding to a sprint is reversible and does not require —confirm.

Examples

Terminal window
simply atlassian jira sprint add 101 PROJ-1 PROJ-2
Terminal window
simply atlassian jira sprint add 101 PROJ-1 --dry-run

simply atlassian jira sprint create

Section titled “simply atlassian jira sprint create”

Create a sprint on a board.

Flags

  • --dry-run — Print the request that would be sent and exit without sending it.
  • --board <value> — Board id the sprint belongs to. (required)
  • --name <value> — Sprint name. (required)
  • --goal <value> — Sprint goal.
  • --start <value> — Start date, ISO-8601.
  • --end <value> — End date, ISO-8601.

Connection

  • -e, --env-file <value> — Path to a .env file holding connection settings.
  • --jira-url <value> — Base URL of the Jira instance. (env: JIRA_URL)
  • --jira-username <value> — Account email for Jira Cloud basic auth. (env: JIRA_USERNAME)
  • --jira-api-token <value> — API token for Jira Cloud basic auth. (env: JIRA_API_TOKEN)
  • --jira-personal-token <value> — Personal access token for Jira Server/Data Center. (env: JIRA_PERSONAL_TOKEN)

Global

  • --json — the raw API payload, for scripts and agents.

The board is given by numeric id; agile commands do not resolve names, because a board name is neither unique nor stable — run “board list” first. Dates are ISO-8601.

Examples

Terminal window
simply atlassian jira sprint create --board 42 --name "Sprint 7"
Terminal window
simply atlassian jira sprint create --board 42 --name "Sprint 7" --start 2026-09-15 --end 2026-09-29

simply atlassian jira sprint issues

Section titled “simply atlassian jira sprint issues”

List issues in a sprint.

Flags

  • --fields <value> — Comma-separated field names to request.
  • --limit <value> — Maximum number of issues to return. (default: 50)

Connection

  • -e, --env-file <value> — Path to a .env file holding connection settings.
  • --jira-url <value> — Base URL of the Jira instance. (env: JIRA_URL)
  • --jira-username <value> — Account email for Jira Cloud basic auth. (env: JIRA_USERNAME)
  • --jira-api-token <value> — API token for Jira Cloud basic auth. (env: JIRA_API_TOKEN)
  • --jira-personal-token <value> — Personal access token for Jira Server/Data Center. (env: JIRA_PERSONAL_TOKEN)

Global

  • --json — the raw API payload, for scripts and agents.

Lists issues for a numeric sprint id using the same compact issue columns as issue search. Use —json for the complete paginated response.

Examples

Terminal window
simply atlassian jira sprint issues 101
Terminal window
simply atlassian jira sprint issues 101 --fields summary,status,assignee --json

simply atlassian jira sprint list

Section titled “simply atlassian jira sprint list”

List a board’s sprints.

Flags

  • --state <value> — Sprint states as CSV: active, future, closed. (default: active,future)
  • --limit <value> — Maximum number of sprints to return. (default: 50)

Connection

  • -e, --env-file <value> — Path to a .env file holding connection settings.
  • --jira-url <value> — Base URL of the Jira instance. (env: JIRA_URL)
  • --jira-username <value> — Account email for Jira Cloud basic auth. (env: JIRA_USERNAME)
  • --jira-api-token <value> — API token for Jira Cloud basic auth. (env: JIRA_API_TOKEN)
  • --jira-personal-token <value> — Personal access token for Jira Server/Data Center. (env: JIRA_PERSONAL_TOKEN)

Global

  • --json — the raw API payload, for scripts and agents.

Lists sprints for a numeric agile board id. Board names are intentionally not resolved; use “jira board list” first when you do not have the id.

Examples

Terminal window
simply atlassian jira sprint list 42
Terminal window
simply atlassian jira sprint list 42 --state closed --limit 10

simply atlassian jira sprint update

Section titled “simply atlassian jira sprint update”

Change a sprint’s name, dates, goal, or state.

Flags

  • --dry-run — Print the request that would be sent and exit without sending it.
  • --name <value> — New sprint name.
  • --goal <value> — New sprint goal.
  • --start <value> — Start date, ISO-8601.
  • --end <value> — End date, ISO-8601.
  • --state <value> — Sprint state. (one of: future, active, closed)

Connection

  • -e, --env-file <value> — Path to a .env file holding connection settings.
  • --jira-url <value> — Base URL of the Jira instance. (env: JIRA_URL)
  • --jira-username <value> — Account email for Jira Cloud basic auth. (env: JIRA_USERNAME)
  • --jira-api-token <value> — API token for Jira Cloud basic auth. (env: JIRA_API_TOKEN)
  • --jira-personal-token <value> — Personal access token for Jira Server/Data Center. (env: JIRA_PERSONAL_TOKEN)

Global

  • --json — the raw API payload, for scripts and agents.

Jira treats a sprint update as a full replacement and clears anything the request omits, so the sprint is read first and your changes applied on top — passing only —name will not blank the goal. —state closed is how a sprint ends; it is reversible, so it takes no —confirm, and —dry-run shows what would be sent.

Examples

Terminal window
simply atlassian jira sprint update 101 --name "Sprint 7 (extended)"
Terminal window
simply atlassian jira sprint update 101 --state closed
Terminal window
simply atlassian jira sprint update 101 --goal "Ship the CLI" --end 2026-10-01 --dry-run