confluence-cli

Read and write Confluence from your terminal — built for coding agents, designed for humans.

Confluence Cloud Data Center / Server Built for agents
confluence-cli in a terminal
Capabilities

One CLI for the whole wiki

Read, search and edit Confluence — with output a coding agent can act on.

Focused page reads

Pull a whole page, or just an outline, one section or keyword matches — an agent loads only the context it needs.

Create & edit pages

Create, update, delete, move and copy pages. Author in Markdown — it converts to storage format — and preview any write with --dry-run.

CQL search

Query with raw CQL, or build one from filter flags: text, author, space, label, type and date ranges.

Comments & threads

Read footer comments and post replies, threaded under any parent comment.

Multiple servers

kubectl-style named contexts in one config file. Switch the current server, or override per command with --use-context.

Agent-first output

JSON by default, with structured errors — categories, exit codes and recovery hints a coding agent can branch on.

Secure credentials

Tokens live in the OS keychain, with a per-user DPAPI fallback on Windows and a 0600 fallback on macOS/Linux — never in the config file.

Cloud & Data Center

One flavor-agnostic client; the backend — Cloud or Data Center / Server — is detected automatically.

Install

Up and running in a minute

Install with npm, then finish setup in two steps — deploy the Skill, then turn on shell completion.

install
# recommended — fetches the prebuilt binary for your platform
npm install -g @angelmsger/confluence-cli

Other methods — go install, a source build, or a prebuilt binary from the Releases page — are in the installation guide.

Then finish setup:

1 · Companion Skill

A confluence Skill is embedded in the binary. It detects your coding agent — Claude Code, Codex — and installs for each:

$ confluence-cli skill install

2 · Shell completion

Completes subcommands, flag values and live space keys. Load it once:

$ source <(confluence-cli completion bash)
Quick start

Configure once, then work the wiki

Set up a server, then read and write from the terminal.

a typical session
# interactive TUI setup, then verify connectivity
$ confluence-cli config init --pretty
$ confluence-cli doctor

# find a page, then read it in stages
$ confluence-cli search --text "release process"
$ confluence-cli page get <id|url> --scope outline
$ confluence-cli page get <id|url> --scope section --section sec-2

# create a page from Markdown, preview before sending
$ confluence-cli page create --space ENG --title "Release Notes" \
    --format markdown --body-file notes.md --dry-run
Commands

The command surface

Eight command groups. Every flag and example lives in the full CLI reference.

Guides

Go deeper

Longer-form documentation, rendered on GitHub.