confluence-cli

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. Resolve me to the current user, then filter page history by actor and time.

Comments & threads

Read footer comments and post threaded replies. Preview the parent and body with --dry-run, including in read-only mode.

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 is detected automatically, with compatible user and page-history paths for older Data Center servers.

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 agents — Claude Code, Codex, Cursor and ten more — and installs for each one found:

$ confluence-cli skill install
# Re-run after CLI upgrades, then reload the agent context.

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

# find pages I edited during a local calendar day
$ confluence-cli search --type page --contributor me --after 2026-09-03 --all --fields id \
  | jq -r '.items[].id' \
  | confluence-cli page history - --actor me \
      --from 2026-09-03T00:00:00+08:00 --to 2026-09-04T00:00:00+08:00

# create a page from Markdown, preview before sending
$ confluence-cli page create --space ENG --title "Release Notes" \
    --body-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.

NDJSON lists stream rows to stdout and preserve continuation cursors in a structured _notice.pagination on stderr. Pass next as --cursor, or use --all for complete output.

page

Read, create, update, delete, move and copy pages; walk the tree and query edit history.

search

CQL search — raw, or built from filter flags.

space

List and inspect Confluence spaces.

comment

Read footer comments and post replies.

attachment

List and download page attachments.

config

Setup wizard, plus multi-server context management.