A scrappy little Confluence CLI for you and your clanker
curl -fsSL https://raw.githubusercontent.com/hochej/confcli/main/install.sh | shOptions via environment variables (these vars must be set on the sh side of the pipe):
curl -fsSL https://raw.githubusercontent.com/hochej/confcli/main/install.sh | VERSION=<latest> sh
curl -fsSL https://raw.githubusercontent.com/hochej/confcli/main/install.sh | INSTALL_DIR=~/.bin shOr download a binary manually from GitHub Releases.
cargo install confcliFor a read-only build (all write commands like create, update, delete are hidden):
cargo install confcli --no-default-featuresShell completions
confcli completions bash > /usr/local/etc/bash_completion.d/confcli # Bash
confcli completions zsh > ~/.zsh/completions/_confcli # Zsh
confcli completions fish > ~/.config/fish/completions/confcli.fish # Fishconfcli auth login # Interactive prompts for domain/email/token
confcli auth status # Verify authentication
confcli space list # List all spacesTip: Generate an API token at https://id.atlassian.com/manage-profile/security/api-tokens
Every command supports --help for full usage details.
| Command | Description |
|---|---|
confcli auth login/status |
Authenticate and verify credentials |
confcli space list/get/pages/create/delete |
Browse and manage spaces (--tree for hierarchy) |
confcli page get/body/history/open |
Read pages — by ID or Space:Title |
confcli page create/update/delete |
Write pages (accepts --body or --body-file) |
confcli page edit |
Edit a page in your $EDITOR (--format adf, --diff) |
confcli search |
Full-text or CQL search (--space to scope) |
confcli attachment list/upload/download/delete |
Manage page attachments |
confcli label list/add/remove/pages |
Tag pages and find pages by label |
confcli comment list/add/delete |
Page comments |
confcli export |
Export page + attachments (--format md|storage, --pattern) |
confcli copy-tree |
Deep-copy a page tree (--exclude, --dry-run) |
- Output formats — All commands accept
-o json,-o table(default), or-o md. - Page content vs metadata —
confcli page get(table) is metadata-only by default; useconfcli page bodyfor content, orconfcli page get --show-bodyif you explicitly want the body in the table. - Compact JSON where APIs are noisy —
confcli space create -o json --compact-jsonprints a small, human-friendly JSON object instead of the full v1 API response. - Dry run — Use
--dry-runbefore any destructive operation to preview what would happen. Space:Titleaddressing — Reference pages asMFS:Overviewinstead of numeric IDs.- Piping —
--body-file -reads from stdin; combine with other tools. - Read-only mode — Compile with
--no-default-featuresto strip all write commands. Useful for shared tooling where you want to prevent accidental modifications.
Credentials are stored as plaintext JSON. On Unix we set restrictive 0600 permissions (best-effort). On Windows, file permissions are managed by NTFS ACLs.
| OS | Path |
|---|---|
| Linux | ~/.config/confcli/config.json (or $XDG_CONFIG_HOME) |
| macOS | ~/Library/Application Support/confcli/config.json |
| Windows | %APPDATA%\confcli\config.json |
For CI/CD or shared environments, use environment variables instead:
export CONFLUENCE_DOMAIN=yourcompany.atlassian.net
export CONFLUENCE_EMAIL=you@example.com
export CONFLUENCE_TOKEN=<api-token> # or CONFLUENCE_API_TOKEN
export CONFLUENCE_BEARER_TOKEN=<bearer> # for OAuth
export CONFLUENCE_API_PATH=/wiki/rest/api # override for Server/DC or proxied instances