Skip to main content

Fetch, render and search Atlassian (Jira + Confluence) content 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 jq.

It complements Atlassian's official acli: acli owns writes, boards and sprints. atl's curated commands stay read-only and focus on rendering and attachment downloads, while atl api is a raw REST escape hatch for anything they don't cover (including writes).

Install

uv tool install atl-cli

This installs the atl command. To install the latest unreleased version from source instead:

uv tool install git+https://github.com/k-papadakis/atl-cli

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 jq), --limit <n> (cap search results; default: all). Run atl --help or atl <command> --help for the rest.

First run atl auth login and provide the site URL, your Atlassian email, and an API token.

Raw API

atl api is a raw passthrough to the Atlassian REST API, modeled on gh api: one command for the whole site (you type the real REST path — Jira /rest/... or Confluence /wiki/... — against one host and token). It reaches any endpoint the curated commands don't cover, read or write.

atl api /wiki/api/v2/pages -f limit=1               # GET query param
atl api /rest/api/3/issue/BST-1/comment -f body=hi  # body present -> POST
  • -X/--method — HTTP method (default GET; POST once there's a body).
  • -f/--raw-field key=value — string field; -F/--field key=value — typed (true/false/null/ints convert; @file/@- reads a value).
  • --input <file|-> — raw request body (fields then go to the query string).
  • -H/--header key:value — add a request header.

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.0.tar.gz (22.6 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.0-py3-none-any.whl (26.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: atl_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 22.6 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.0.tar.gz
Algorithm Hash digest
SHA256 abdd780663e2688ba33095e8468f58478d5058d3dc89b2ec4e172b77d4da277a
MD5 8b0c686eadbe3271e4bcf3560543f45d
BLAKE2b-256 14640273b9f0870ee141173c75ddc1ef81d7ae176afafed2cbcc1b1db9baa8de

See more details on using hashes here.

File details

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

File metadata

  • Download URL: atl_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 26.9 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 938f6b4411e01c518b386cdf1d4ba7f80a41354ce801f08570377ef0ec6ab581
MD5 e352c7a91fac76b5d246e705363ea727
BLAKE2b-256 c278b5cc84452be07ae999a406db55028b8f6126fa194cd8137382464556d8be

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