Skip to main content

Render Atlassian (Jira + Confluence) content as clean Markdown in the terminal.

Project description

atl

atl fetches Atlassian (Jira + Confluence) content from the terminal and renders the HTML the REST APIs return as clean Markdown. It's built for AI agents: view folds a work item or page and its context — comments, links, sub-tasks, children, attachments — into a single Markdown document, and every command has an --output json mode for scripting.

For anything the curated commands don't cover, atl api is a raw, authenticated passthrough to the Atlassian REST API, modeled on gh api: type the real Jira (/rest/...) or Confluence (/wiki/...) path against your configured host and token — reads or writes.

Install

uv tool install atl-cli

This installs the atl command.

Authentication

Run atl auth login once. It prompts for your site URL, your Atlassian email, and an API token, then verifies them before saving.

  • Non-secret metadata (site URL and username) is written to ~/.config/atl/credentials.json (mode 600; honors XDG_CONFIG_HOME).
  • The API token is stored in your OS keyring; if no keyring backend is available it falls back into that same mode-600 file.

atl auth status shows the configured site and account and re-verifies the token; atl auth logout removes both the file and the keyring entry.

Usage

atl jira       view <KEY>                work item + comments, links, sub-tasks,
                                         attachments (+ epic children, for epics)
atl jira       search <jql>              search work items with JQL
atl jira       download-attachment <id>  download a work-item attachment by id
atl confluence view <id>                 wiki page + child pages + attachments
atl confluence search <cql>              search pages with CQL
atl confluence download-attachment <id>  download a page attachment by id
atl            api <endpoint>            raw authenticated REST request to any
                                         Jira/Confluence endpoint (gh-style)
atl auth       login | logout | status

Common options: --web (open in a browser instead of rendering), --output json (raw API JSON for scripting), --limit <n> (cap search results; default: all). Run atl --help or atl <command> --help for the rest.

Examples

atl jira view PROJ-123                        # render a work item as Markdown
atl jira search 'assignee = currentUser() AND statusCategory != Done'
atl confluence view 123456                    # render a page (numeric id)
atl confluence search 'text ~ "onboarding"'
atl jira view PROJ-123 --web                  # open in a browser instead

atl api /rest/api/3/myself                    # raw REST call, pretty-printed JSON
atl api /wiki/api/v2/pages -f limit=5 -X GET  # a field defaults to POST; -X GET forces a query

# write with a raw body (add a Jira comment, in Atlassian Document Format):
echo '{"body":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"type":"text","text":"hi"}]}]}}' |
  atl api /rest/api/3/issue/PROJ-123/comment --input -

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

atl_cli-0.1.1.tar.gz (22.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

atl_cli-0.1.1-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

Details for the file atl_cli-0.1.1.tar.gz.

File metadata

  • Download URL: atl_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 22.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for atl_cli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 d71dd0c973b542e07653779669697e5a19578f68118437e3451a06c4175037ae
MD5 cb8f8f8c5c44db127e1e10b4395635c0
BLAKE2b-256 b788fe19d9ef9ef3f8c6e5646247d8d321bb6426528977bbe66ee4e170fb43f7

See more details on using hashes here.

File details

Details for the file atl_cli-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: atl_cli-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 27.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for atl_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2ef5b2e77f87f228c548ad9bdc9d64c8aeb19b1ed8cb74336c3cb6f89962d331
MD5 121d76dd28c1aae0fb47e3e9061ffa09
BLAKE2b-256 48da6c5ebc57c08e4886ef10f72653184be72a0fe51c09a4682497e2f5cd3a8d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page