atlassian-cli

CLI for Atlassian Server and Data Center products.

Install

python3 -m venv .venv && .venv/bin/pip install -e '.[dev]'

Install From GitHub Release

Tagged releases publish standalone bundles for linux/amd64, darwin/arm64, darwin/amd64, and windows/amd64, plus checksums.txt.

Install the latest Linux or macOS binary release:

curl -fsSL https://raw.githubusercontent.com/LichKing-2234/atlassian-cli/main/install.sh | sh

Install a specific Linux or macOS release:

curl -fsSL https://raw.githubusercontent.com/LichKing-2234/atlassian-cli/main/install.sh | env INSTALL_VERSION=v0.1.0 sh

Install the latest Windows amd64 release from PowerShell:

irm https://raw.githubusercontent.com/LichKing-2234/atlassian-cli/main/install.ps1 | iex

Install a specific Windows release:

$env:INSTALL_VERSION = "v0.1.0"; irm https://raw.githubusercontent.com/LichKing-2234/atlassian-cli/main/install.ps1 | iex

By default the Unix shell installer writes an atlassian launcher to ~/.local/bin and installs the runtime bundle under ~/.local/bin/.atlassian-cli. It supports Linux amd64 and macOS arm64/amd64. The PowerShell installer writes atlassian.cmd to the same default install directory on Windows and installs the runtime bundle under ~/.local/bin/.atlassian-cli.

You can also download a tarball or Windows zip from the GitHub Release page. Unix bundles run atlassian/atlassian from the extracted bundle; Windows bundles run atlassian/atlassian.exe. If you do not use a Unix-like shell on Windows, download atlassian-cli_<version>_windows_amd64.zip, extract it, and run atlassian/atlassian.exe.

macOS binaries are unsigned in the first release version, so macOS may require a manual Gatekeeper allow step on first run.

Update

On interactive commands, the CLI checks for a newer GitHub Release at most once every 24 hours and prints an update notice to stderr when a newer release exists. It never installs updates automatically, and JSON/YAML command output is not modified.

Set ATLASSIAN_DISABLE_UPDATE_CHECK=1 to disable the automatic check.

Check for a newer GitHub Release:

atlassian update check

Install the latest release:

atlassian update install

Install a specific release, or choose a non-default install directory:

atlassian update install --version v0.1.0
atlassian update install --install-dir ~/.local/bin

atlassian update install uses the same installer and checksum verification as the GitHub Release install command.

Configure

Run the setup wizard:

atlassian init

Configure one product:

atlassian init jira

Use flags for non-interactive setup:

atlassian init bitbucket --deployment dc --url https://bitbucket.example.com --auth pat --token secret

Existing product config is not overwritten by default. Use --force when replacing a product block non-interactively:

atlassian init confluence --force --deployment server --url https://confluence.example.com --auth basic --username example-user --token secret

The default ~/.config/atlassian-cli/config.toml file is still auto-created as a template on first product command when it does not already exist.

Examples

• atlassian jira issue get DEMO-1
• atlassian confluence page get 1234
• atlassian bitbucket repo get DEMO example-repo
• atlassian bitbucket pr list DEMO example-repo
• atlassian bitbucket pr diff DEMO example-repo 42
• atlassian bitbucket pr comment list DEMO example-repo 42
• atlassian bitbucket pr comment add DEMO example-repo 42 "example comment"
• atlassian bitbucket pr build-status DEMO example-repo 42
• atlassian bitbucket commit build-status abc123
• atlassian bitbucket pr list DEMO example-repo --output json

Header injection

The CLI can accept externally generated HTTP headers without embedding OAuth logic.

Command-line example:

• atlassian --url https://bitbucket.example.com --header 'accessToken: ...' bitbucket pr list DEMO example-repo

Config file example:

[headers]
X-Request-Source = "example-oauth"

[bitbucket]
deployment = "dc"
url = "https://bitbucket.example.com"
auth = "pat"

[bitbucket.headers]
accessToken = "$(example-oauth token)"

• atlassian bitbucket pr list DEMO example-repo

Config-backed header values may execute local shell commands through $(...). Treat ~/.config/atlassian-cli/config.toml as trusted local configuration. Command substitution runs through /bin/sh on Unix-like systems and cmd.exe on Windows. The default ~/.config/atlassian-cli/config.toml file is auto-created as a template on first use. Only top-level [jira], [confluence], [bitbucket], and [headers] are supported.

Output Modes

The CLI now uses markdown as the default human-readable output mode.

• Single-resource commands default to markdown detail output.
• Collection commands default to an interactive browser in a TTY.
• Collection commands fall back to markdown summary output outside a TTY.
• Confluence page detail output renders storage HTML content into readable Markdown in --output markdown.
• Use --output json or --output yaml for normalized machine-readable output.
• Use --output raw-json to inspect the original provider response as JSON.
• Use --output raw-yaml to inspect the original provider response as YAML.
• Commands that compose multiple provider calls, such as bitbucket pr build-status, group the unnormalized provider payloads in raw output.

Examples:

• atlassian jira issue get DEMO-1
• atlassian jira issue search --jql 'project = DEMO'
• atlassian confluence space list
• atlassian bitbucket pr list DEMO example-repo
• atlassian bitbucket pr diff DEMO example-repo 42
• atlassian bitbucket pr comment list DEMO example-repo 42
• atlassian bitbucket pr build-status DEMO example-repo 42
• atlassian bitbucket commit build-status abc123
• atlassian jira issue get DEMO-1 --output json
• atlassian bitbucket pr list DEMO example-repo --output json

Interactive browser behavior

TTY collection commands open a compact browser instead of printing a long static list.

• The top region is a dense single-line-per-item list for fast scanning.
• The bottom preview is a live preview that shows metadata for the selected item without opening full detail.
• Enter opens the full markdown detail view for the selected item.
• Bitbucket pull request detail lazily loads the textual diff when you open detail.
• Detail view supports scrolling with j/k, arrow keys, and PageUp/PageDown.
• b or Esc returns from detail to the list.
• / filters only the items already loaded into the current browser session.
• r refreshes the first page and returns the browser to list mode.

Keybindings:

j/k move n/p page / filter r refresh enter detail b/esc back q quit

Bitbucket pull request diff behavior:

• atlassian bitbucket pr diff DEMO example-repo 42 shows ANSI-colored diff output in a TTY.
• The same command falls back to plain text when redirected or piped.

Bitbucket pull request comments and build status behavior:

• atlassian bitbucket pr comment list DEMO example-repo 42 lists pull request comments.
• atlassian bitbucket pr comment edit DEMO example-repo 42 1001 "example comment" --version 3 requires the current comment version.
• atlassian bitbucket pr build-status DEMO example-repo 42 summarizes build statuses for pull request commits.
• atlassian bitbucket pr build-status DEMO example-repo 42 --latest-only checks only the pull request head commit.
• atlassian bitbucket commit build-status abc123 checks a specific commit.

Scope

The CLI now covers the mcp-atlassian TOOLSETS=default Jira and Confluence command groups for Server/Data Center:

• Jira issues, fields, comments, and transitions
• Confluence pages and comments

Normalized json and yaml output now follows MCP-style resource envelopes more closely. This is a breaking change for scripts that consumed older normalized output.

Raw modes with unchanged behavior:

• raw-json
• raw-yaml

One default MCP capability remains explicitly unsupported in CLI v1: Jira batch changelog fetch. That workflow depends on Cloud support, and the current CLI still rejects --deployment cloud.

Contributing

Contributor workflows, including local setup, smoke tests, live e2e execution, CI/release notes, and maintenance checklists, are documented in CONTRIBUTING.md.