Command Reference

Every atlassian-cli command grouped by product. Examples use the default profile; add --profile <name> to target a different one. See Authentication to configure profiles.

Global flags

All commands accept these:

--profile <name> — use a specific auth profile (default: the one marked default in auth list)
--format <table|json|csv|yaml|quiet|markdown> or -f — output format (default: table)
--envelope — wrap JSON/YAML list output in {"data": [...], "count": N} for easier downstream parsing
--config <path> — use a non-default config file instead of ~/.atlassian-cli/config.yaml
--debug — log HTTP request/response details for troubleshooting
--help — print command help

Bulk subcommands additionally accept --dry-run, --concurrency <n>, and --limit <n>.

Output formats

# Human-readable table (default)
atlassian-cli jira search --jql "project = DEV"

# Machine-readable JSON — pipe to jq, feed other tools
atlassian-cli jira search --jql "project = DEV" --format json | jq '.[].key'

# CSV — open in a spreadsheet
atlassian-cli jira search --jql "project = DEV" --format csv --output issues.csv

# YAML — good for configuration diffs
atlassian-cli jira workflows export --name "Software Simplified Workflow" --format yaml

# Quiet — exit code only; useful in CI gating
atlassian-cli auth test --profile prod --format quiet && echo OK

auth

See Authentication & Profiles for the full guide. Available subcommands: login, logout, list, status, whoami, test.

atlassian-cli auth login --profile work --base-url https://x.atlassian.net --email you@x.com --token $TOKEN --default
atlassian-cli auth list
atlassian-cli auth status
atlassian-cli auth whoami --profile work
atlassian-cli auth test --profile work
atlassian-cli auth logout --profile old                    # remove credentials, keep profile
atlassian-cli auth logout --profile old --remove-profile   # remove profile entirely
atlassian-cli auth logout --profile old --bitbucket        # only remove Bitbucket token

To change which profile is default, re-run auth login --default for the profile you want as default, or edit default_profile: in ~/.atlassian-cli/config.yaml directly.

Jira — Issues

atlassian-cli jira search --jql "project = DEV order by created desc" --limit 5
atlassian-cli jira get DEV-123
atlassian-cli jira create --project DEV --issue-type Task --summary "Test task"

# Custom fields — discover IDs via `jira fields list`
atlassian-cli jira create --project DEV --issue-type Task --summary "cf test" \
  --field 'customfield_10010={"value":"Internal"}' \
  --field 'customfield_10020={"formula":"a=b"}'

atlassian-cli jira update DEV-123 --summary "Updated summary"
atlassian-cli jira transition DEV-123 --transition "In Progress"
atlassian-cli jira assign DEV-123 --assignee user@example.com
atlassian-cli jira delete DEV-123

Jira — Projects

atlassian-cli jira project list
atlassian-cli jira project get DEV
atlassian-cli jira components list --project DEV
atlassian-cli jira versions list --project DEV

Jira — Roles

atlassian-cli jira roles list --project DEV
atlassian-cli jira roles get --project DEV --role-id 10002
atlassian-cli jira roles actors --project DEV --role-id 10002
atlassian-cli jira roles add-actor --project DEV --role-id 10002 --user user@example.com
atlassian-cli jira roles remove-actor --project DEV --role-id 10002 --user user@example.com

Jira — Fields & workflows

atlassian-cli jira fields list
atlassian-cli jira workflows list
atlassian-cli jira workflows export --name "Software Simplified Workflow"

Jira — Bulk operations

# Dry-run first — always
atlassian-cli jira bulk transition \
  --jql "project = DEV AND status = Open" \
  --transition "In Progress" \
  --dry-run

atlassian-cli jira bulk assign \
  --jql "project = DEV AND assignee is EMPTY" \
  --assignee admin@example.com

atlassian-cli jira bulk export \
  --jql "project = DEV" \
  --output issues.json --format json

All bulk commands respect --concurrency (default 4) and show a live progress bar unless --format quiet is set.

Jira — Automation & webhooks

atlassian-cli jira automation list
atlassian-cli jira webhooks list
atlassian-cli jira audit list --from 2025-01-01 --limit 100

Confluence — Search

atlassian-cli confluence search cql --cql "space = DEV and type = page" --limit 5
atlassian-cli confluence search text --query "meeting notes" --limit 10
atlassian-cli confluence search in-space --space DEV --query "api docs"

Confluence — Spaces

atlassian-cli confluence space list --limit 10
atlassian-cli confluence space get DEV
atlassian-cli confluence space create --key DOCS --name "Documentation" --description "Team docs"
atlassian-cli confluence space update DEV --name "Development Space"
atlassian-cli confluence space delete OLD --force
atlassian-cli confluence space permissions DEV
atlassian-cli confluence space add-permission DEV --principal user@example.com --operation read

Confluence — Pages

atlassian-cli confluence page list --space DEV --limit 25
atlassian-cli confluence page get --id 12345
atlassian-cli confluence page create --space DEV --title "New Page" --body "<p>Content</p>"
atlassian-cli confluence page update --id 12345 --title "Updated Title"
atlassian-cli confluence page delete --id 12345
atlassian-cli confluence page versions --id 12345
atlassian-cli confluence page add-label --id 12345 --label documentation
atlassian-cli confluence page remove-label --id 12345 --label outdated
atlassian-cli confluence page comments --id 12345
atlassian-cli confluence page add-comment --id 12345 --body "Great work!"
atlassian-cli confluence page get-restrictions --id 12345
atlassian-cli confluence page add-restriction --id 12345 --operation update --user user@example.com
atlassian-cli confluence page remove-restriction --id 12345 --operation update --user user@example.com

Confluence — Blog posts

atlassian-cli confluence blog list --space DEV --limit 10
atlassian-cli confluence blog get --id 67890
atlassian-cli confluence blog create --space DEV --title "Sprint Recap" --body "<p>Summary</p>"
atlassian-cli confluence blog update --id 67890 --title "Updated Recap"
atlassian-cli confluence blog delete --id 67890

Confluence — Attachments

atlassian-cli confluence attachment list --page-id 12345
atlassian-cli confluence attachment get --id 11111
atlassian-cli confluence attachment upload --page-id 12345 --file ./diagram.png
atlassian-cli confluence attachment download --id 11111 --output ./download.png
atlassian-cli confluence attachment delete --id 11111

Confluence — Bulk operations

atlassian-cli confluence bulk delete --space OLD --dry-run
atlassian-cli confluence bulk add-labels --cql "space = DEV" --labels docs,reviewed --dry-run
atlassian-cli confluence bulk export --space DEV --output backup.json --format json

For a full markdown-to-Confluence pipeline see the Markdown sync runbook.

Confluence — Analytics

atlassian-cli confluence analytics page-views --id 12345 --from 2025-01-01
atlassian-cli confluence analytics space-stats --space DEV

Bitbucket — User info

bb is an alias for bitbucket. Both work in every command below.

atlassian-cli bitbucket whoami
atlassian-cli bb whoami

Bitbucket — Repositories

atlassian-cli bitbucket --workspace myteam repo list --limit 10
atlassian-cli bitbucket --workspace myteam repo get api-service
atlassian-cli bitbucket --workspace myteam repo create newrepo --name "New Repo" --private
atlassian-cli bitbucket --workspace myteam repo update api-service --description "Updated description"
atlassian-cli bitbucket --workspace myteam repo delete oldrepo --force

Bitbucket — Branches

atlassian-cli bitbucket --workspace myteam branch list api-service
atlassian-cli bitbucket --workspace myteam branch create api-service feature/new --from main
atlassian-cli bitbucket --workspace myteam branch delete api-service feature/old --force
atlassian-cli bitbucket --workspace myteam branch protect api-service --pattern "main" --kind restrict_merges --approvals 2
atlassian-cli bitbucket --workspace myteam branch restrictions api-service

Bitbucket — Pull requests

atlassian-cli bitbucket --workspace myteam pr list api-service --state OPEN --limit 5
atlassian-cli bitbucket --workspace myteam pr get api-service 123
atlassian-cli bitbucket --workspace myteam pr create api-service --title "Add feature" --source feature/new --destination main
atlassian-cli bitbucket --workspace myteam pr update api-service 123 --title "Updated title"
atlassian-cli bitbucket --workspace myteam pr approve api-service 123
atlassian-cli bitbucket --workspace myteam pr merge api-service 123 --strategy merge_commit
atlassian-cli bitbucket --workspace myteam pr comments api-service 123
atlassian-cli bitbucket --workspace myteam pr comment api-service 123 --text "Looks good!"

Bitbucket — Workspaces & projects

atlassian-cli bitbucket workspace list --limit 10
atlassian-cli bitbucket workspace get myteam
atlassian-cli bitbucket --workspace myteam project list
atlassian-cli bitbucket --workspace myteam project create PROJ --name "My Project" --private
atlassian-cli bitbucket --workspace myteam project delete PROJ --force

Bitbucket — Pipelines

atlassian-cli bitbucket --workspace myteam pipeline list api-service
atlassian-cli bitbucket --workspace myteam pipeline trigger api-service --ref-name main
atlassian-cli bitbucket --workspace myteam pipeline stop api-service {uuid}

Bitbucket — Webhooks & SSH keys

atlassian-cli bitbucket --workspace myteam webhook list api-service
atlassian-cli bitbucket --workspace myteam webhook create api-service --url https://example.com/hook --events repo:push
atlassian-cli bitbucket --workspace myteam ssh-key list api-service
atlassian-cli bitbucket --workspace myteam ssh-key add api-service --label deploy --key "ssh-rsa ..."

Bitbucket — Permissions & commits

atlassian-cli bitbucket --workspace myteam permission list api-service
atlassian-cli bitbucket --workspace myteam permission grant api-service --user-uuid {uuid} --permission write
atlassian-cli bitbucket --workspace myteam commit list api-service --branch main
atlassian-cli bitbucket --workspace myteam commit diff api-service abc123
atlassian-cli bitbucket --workspace myteam commit browse api-service --commit main --path src/

Bitbucket — Bulk operations

atlassian-cli bitbucket --workspace myteam bulk archive-repos --days 180 --dry-run
atlassian-cli bitbucket --workspace myteam bulk delete-branches api-service --exclude feature/keep --dry-run

JSM — Service desks

atlassian-cli jsm service-desk list --limit 25
atlassian-cli jsm service-desk get 10
atlassian-cli jsm service-desk customers 10 --limit 25
atlassian-cli jsm service-desk add-customer 10 --account-id 5f...1a --account-id 6a...2b
atlassian-cli jsm service-desk remove-customer 10 --account-id 5f...1a
atlassian-cli jsm service-desk organizations 10
atlassian-cli jsm service-desk add-organization 10 --org-id 42
atlassian-cli jsm service-desk remove-organization 10 --org-id 42

JSM — Request types

atlassian-cli jsm request-type list --servicedesk-id 10 --limit 25
atlassian-cli jsm request-type get 10 7
atlassian-cli jsm request-type fields 10 7
atlassian-cli jsm request-type groups 10

JSM — Requests

atlassian-cli jsm request list --servicedesk-id 10 --limit 25
atlassian-cli jsm request get SD-123
atlassian-cli jsm request create --servicedesk-id 10 --request-type-id 7 --summary "Access issue" --description "Can't log in"
atlassian-cli jsm request transitions SD-123
atlassian-cli jsm request transition SD-123 --transition "In Progress"
atlassian-cli jsm request status SD-123
atlassian-cli jsm request comments SD-123 --limit 25
atlassian-cli jsm request add-comment SD-123 --body "Investigating" --public
atlassian-cli jsm request participants SD-123
atlassian-cli jsm request add-participant SD-123 --account-id 5f...1a
atlassian-cli jsm request remove-participant SD-123 --account-id 5f...1a
atlassian-cli jsm request subscribe SD-123
atlassian-cli jsm request unsubscribe SD-123

JSM — Queues

atlassian-cli jsm queue list 10
atlassian-cli jsm queue get 10 5
atlassian-cli jsm queue issues 10 5 --limit 25

JSM — Approvals

atlassian-cli jsm approval list SD-123
atlassian-cli jsm approval get SD-123 --approval-id 1
atlassian-cli jsm approval approve SD-123 --approval-id 1
atlassian-cli jsm approval decline SD-123 --approval-id 1

JSM — SLAs

atlassian-cli jsm sla list SD-123
atlassian-cli jsm sla get SD-123 --sla-id time-to-resolution

JSM — Customers

atlassian-cli jsm customer create --email new@customer.com --display-name "New Customer"
atlassian-cli jsm customer revoke-portal-access --account-id 5f...1a

JSM — Organizations

atlassian-cli jsm organization list --limit 25
atlassian-cli jsm organization get 42
atlassian-cli jsm organization create --name "ACME Ops"
atlassian-cli jsm organization users 42 --limit 25
atlassian-cli jsm organization add-user 42 --account-id 5f...1a
atlassian-cli jsm organization remove-user 42 --account-id 5f...1a
atlassian-cli jsm organization delete 42

JSM — Knowledge base

atlassian-cli jsm kb search --query "vpn" --servicedesk-id 10 --limit 25

JSM — Feedback

atlassian-cli jsm feedback get SD-123
atlassian-cli jsm feedback submit SD-123 --rating 5 --comment "Great help"
atlassian-cli jsm feedback delete SD-123

Next: see the runbooks for production examples, or head to the blog for deep-dives.