confluence-cli

Use Confluence as a knowledge base from your terminal — built for coding agents.

confluence-cli lets coding agents (Claude Code and others) — and humans — read, search and maintain a Confluence instance from the command line: fetch and edit pages, manage attachments, labels and comments. It speaks to both Confluence Cloud and Data Center / Server, returns agent-friendly JSON with structured errors, and ships a companion Skill that teaches an agent how to use it. Write commands support --dry-run, and destructive ones require --yes.

📖 Documentation site: https://angelmsger.github.io/confluence-cli/

Features

• Cloud & Data Center — one flavor-agnostic client; the backend is detected automatically.
• Agent-friendly — JSON output by default, structured errors with exit codes and recovery hints, and partial page reads (outline / section / keyword) so an agent spends minimal context.
• Read & write — fetch pages and browse trees, CQL search; create, edit, move, delete and restore pages; manage attachments, labels, comments and page watches. Every write supports --dry-run; destructive commands need --yes.
• Time-bounded edit history — find pages the current user contributed to, then filter their version history by actor and an exact time window.
• Flexible configuration — CLI flags, environment variables, a .env file, a YAML config file, or an interactive wizard; secrets stored in the OS keychain.
• Companion Skill — a confluence Skill, embedded in the binary, that guides coding agents through the CLI.

Installation

Install the CLI with npm, then take two short steps to finish setup — deploy the companion Skill, then (optionally) enable shell completion.

1. Install the CLI — npm (recommended)

npm install -g @angelmsger/confluence-cli

npm downloads the prebuilt binary for your platform, verifies its SHA-256 checksum, and keeps upgrades one npm update -g @angelmsger/confluence-cli away.

go install github.com/angelmsger/confluence-cli/cmd/confluence-cli@latest   # go 1.24+
make install                                                                # from a source checkout

Or download a prebuilt binary from the Releases page. The full installation guide covers every method.

2. Deploy the companion Skill

The confluence Skill is embedded in the binary; it teaches your coding agent (Claude Code, Codex, Cursor, Agents (shared), Gemini CLI, GitHub Copilot, OpenCode, Continue, Windsurf, Grok Build, Pi, Kilo Code, and Roo Code) how to drive the CLI. skill install probes for installed agents and installs into each one found:

confluence-cli skill install            # auto-detect; install for each agent found
confluence-cli skill install --agent codex
confluence-cli skill status             # compare loaded, installed, embedded versions
confluence-cli skill uninstall          # remove it again

After upgrading the CLI, re-run skill install and reload the agent context. Details, including the npx skills workflow, are in docs/installation.md.

3. Enable shell completion (optional)

confluence-cli completes subcommands, enum flag values and live space keys. Load the completion script for your shell once:

source <(confluence-cli completion bash)                       # bash, current shell
confluence-cli completion zsh > "${fpath[1]}/_confluence-cli"   # zsh, persistent

fish, PowerShell and persistent setup are covered in docs/installation.md.

Quick start

confluence-cli config init --pretty   # interactive TUI setup (recommended for humans)
confluence-cli doctor                 # verify configuration and connectivity

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
confluence-cli comment list <id|url>

Configuration

Settings resolve in precedence order (highest first): CLI flags → environment variables (CONFLUENCE_*) → .env → ~/.angelmsger/confluence/config.yaml (legacy fallback ~/.confluence/config.yaml) → defaults. See .env.example and docs/installation.md. Secrets are stored in the OS keychain. If Windows Credential Manager is unavailable, the fallback is encrypted with per-user DPAPI; macOS/Linux retain the 0600 fallback. Secrets are never written to the config file.

This is the beginning of the README. Read the rest at the original. Read the full README ↗