Skip to content

Command reference

atlassian

Jira, Confluence, Jira Service Management and Agile from the command line

Synopsis

atlassian is a command-line client for the whole Atlassian Cloud and Data Center REST surface: Jira, Jira Software (Agile), Jira Service Management and Confluence.

Everyday work has ergonomic commands (issues, projects, sprints, pages, requests). Every other documented operation — 1,143 in total — is reachable by name through 'atlassian op', which is generated from Atlassian's own OpenAPI documents and validates parameters before sending anything.

Examples

# Set up a site (Cloud API token, or a Data Center personal access token)
  atlassian init

  # Jira
  atlassian issues list --jql 'project = PP AND status = "In Progress"'
  atlassian issues get PP-1065
  atlassian issues transition PP-1065 --to Done
  atlassian issues comment PP-1065 --body 'Deployed — see the **runbook**'

  # Confluence
  atlassian pages list --space ENG
  atlassian pages get 123456 -o json

  # Agile
  atlassian sprints list --board 42 --state active

  # Anything else in the API, by operation id
  atlassian op search sprint
  atlassian op call getIssue --param issueIdOrKey=PP-1065

Options

      --base-url string   override the site's base URL
      --columns strings   columns to show in table/csv output
      --dry-run           print the equivalent curl command and send nothing
  -h, --help              help for atlassian
      --jq string         filter the result through a gojq expression
      --no-color          disable colored output
  -o, --output string     output format: table|json|yaml|csv|id (default "table")
      --quiet             suppress notes and warnings
      --rps float         client-side request rate limit (requests/second) (default 10)
      --show-token        do not redact credentials in --dry-run output
      --site string       named site to use
      --timeout int       per-request timeout in seconds (default 60)
  -v, --verbose           trace requests to stderr

SEE ALSO