confluence-cf

Confluence CLI built for AI agents — pure JSON output, semantic exit codes, 200+ auto-generated commands, and built-in jq filtering.

Give your AI agent (Claude Code, Cursor, Copilot, or custom bots) reliable, token-efficient access to Confluence Cloud.

Install

pip install confluence-cf
# or
uv tool install confluence-cf

Why cf?

# Full Confluence response: ~8,000 tokens
cf pages get --id 12345

# With cf's filtering: ~50 tokens
cf pages get --id 12345 --fields id,title --jq '{id: .id, title: .title}'

All output is JSON — stdout for data, stderr for errors, always
Semantic exit codes — 0=ok, 2=auth, 3=not_found, 5=rate_limited — agents can branch without parsing
200+ commands from the official Confluence OpenAPI spec, synced daily
Batch operations — N API calls in one process via cf batch
Self-describing — cf schema lets agents discover commands at runtime
Workflow helpers — cf workflow move, cf workflow copy, cf workflow archive

Quick start

# Configure
cf configure --base-url https://yoursite.atlassian.net --token YOUR_API_TOKEN

# Search pages
cf search search-content --cql "space = DEV AND type = page" \
  --jq '.results[] | {id, title}'

# Export a page tree
cf export --id 12345 --tree

# Batch operations
echo '[
  {"command":"pages get","args":{"id":"12345"},"jq":".title"},
  {"command":"pages get","args":{"id":"67890"},"jq":".title"}
]' | cf batch

Also available via

Homebrew: brew install sofq/tap/cf
npm: npm install -g confluence-cf
Scoop: scoop bucket add sofq https://github.com/sofq/scoop-bucket && scoop install cf
Docker: docker run --rm ghcr.io/sofq/cf version
Go: go install github.com/sofq/confluence-cli@latest

Documentation

Full docs, Claude Code skill, and source at github.com/sofq/confluence-cli.

Development Status
- 4 - Beta
Environment
- Console
Intended Audience
- Developers
Programming Language
- Python :: 3
Topic
- Software Development :: Libraries

Download files

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

Source Distribution

confluence_cf-1.2.7.tar.gz (3.4 kB view details)

Uploaded Jun 15, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

confluence_cf-1.2.7-py3-none-any.whl (3.7 kB view details)

Uploaded Jun 15, 2026 Python 3

File details

Details for the file confluence_cf-1.2.7.tar.gz.

File metadata

Download URL: confluence_cf-1.2.7.tar.gz
Upload date: Jun 15, 2026
Size: 3.4 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for confluence_cf-1.2.7.tar.gz
Algorithm	Hash digest
SHA256	`a28d7e515fe1518a256f1c99547e7170491194b7242b5a4d69f6f7e51477b4f3`
MD5	`c401dd7eb9320ab8ff015df512c4a12c`
BLAKE2b-256	`c1ba9d8c425091becca9c9d8a9470d6f61347644efc018baeb98a6037fa06e6d`

See more details on using hashes here.

Provenance

The following attestation bundles were made for confluence_cf-1.2.7.tar.gz:

Publisher: release.yml on sofq/confluence-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: confluence_cf-1.2.7.tar.gz
- Subject digest: a28d7e515fe1518a256f1c99547e7170491194b7242b5a4d69f6f7e51477b4f3
- Sigstore transparency entry: 1821521604
- Sigstore integration time: Jun 15, 2026
Source repository:
- Permalink: sofq/confluence-cli@f1c96546c82e18b230a9b0d1d6338f83448dc40f
- Branch / Tag: refs/tags/v1.2.7
- Owner: https://github.com/sofq
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@f1c96546c82e18b230a9b0d1d6338f83448dc40f
- Trigger Event: push