conf-cli

Confluence Cloud CLI for automation and Claude Code integration. 47 commands across 11 command groups with JSON output.

Installation

npm install -g @salient-ai/conf-cli

Or run without installing:

npx @salient-ai/conf-cli --help

Either way, the CLI is invoked as conf.

Development Setup

To work on conf-cli itself from a git clone:

npm install
npm run build
npm link  # installs `conf` globally, pointing at your local build

Configure Credentials

Run conf init in your project to set it up for conf-cli: pick an existing profile or create a new one, optionally configure Claude Code and/or Codex CLI for this repo (guidance file + skill), and test the connection. Safe to re-run — it won't duplicate content or clobber hand-edited skill files.

conf init

Or configure a profile manually:

conf config add-profile mysite \
  --confluence-url https://mysite.atlassian.net \
  --confluence-email [email protected] \
  --confluence-api-token YOUR_API_TOKEN \
  --set-default

Or use environment variables: CONFLUENCE_URL, CONFLUENCE_EMAIL, CONFLUENCE_API_TOKEN

Output Format

All commands output structured JSON:

# Success (stdout, exit 0):
{"success": true, "data": {...}}

# Error (stderr, exit 1):
{"success": false, "error": "message", "status_code": 404}

Global Options

| Option | Description | |--------|-------------| | --profile, -p | Named credential profile | | --llm-help | Print compact CLI reference for LLM consumption |

Commands

Init (1 command)

conf init  # pick/create a profile, optionally configure Claude Code and/or Codex CLI, test the connection

Config (4 commands)

conf config add-profile <name> --confluence-url <url> --confluence-email <email> --confluence-api-token <token> [--set-default]
conf config list-profiles
conf config remove-profile <name>
conf config set-default <name>

Space (6 commands)

conf space list [--type global|personal] [--status current|archived] [--limit 25]
conf space get <spaceId>
conf space get-by-key <spaceKey>
conf space create <key> <name> [--description "text"]
conf space update <spaceId> [--name "name"] [--description "text"]
conf space delete <spaceId>

Page (11 commands)

conf page create <spaceKey> <title> [--body "markdown"] [--body-file path] [--parent-id id]
conf page get <pageId> [--include-body]
conf page get-by-title <spaceKey> <title> [--include-body]
conf page update <pageId> [--title "text"] [--body "md"] [--body-file path] [--version-message "msg"]
conf page delete <pageId> [--purge]
conf page archive <pageId>
conf page unarchive <pageId>
conf page children <pageId> [--limit 25]
conf page move <pageId> --parent-id <id>
conf page versions <pageId> [--limit 25]
conf page search <cql> [--limit 25] [--include-body]

Body content accepts markdown, auto-converted to Confluence storage format. Response bodies auto-converted back to markdown.

Comment (5 commands)

conf comment add <pageId> --body "markdown"
conf comment list <pageId> [--limit 25]
conf comment update <commentId> --body "markdown"
conf comment delete <commentId>
conf comment versions <commentId>

Attachment (5 commands)

conf attachment list <pageId> [--limit 25]
conf attachment get <attachmentId>
conf attachment add <pageId> <filePath> [--comment "text"]
conf attachment delete <attachmentId>
conf attachment download <attachmentId>

Label (4 commands)

conf label list <pageId> [--limit 25]
conf label add <pageId> label1 label2 label3
conf label remove <pageId> <label>
conf label list-space <spaceId> [--limit 25]

Property (4 commands)

conf property list <pageId> [--limit 25]
conf property get <pageId> <key>
conf property set <pageId> <key> <value>
conf property delete <pageId> <key>

Watcher (3 commands)

conf watcher list <pageId>
conf watcher add <pageId>      # current user
conf watcher remove <pageId>   # current user

Bulk (4 commands)

conf bulk update-pages --file updates.json
conf bulk add-labels --page-ids 123 456 --labels important reviewed
conf bulk delete-pages --page-ids 123 456
conf bulk archive-pages --page-ids 123 456

Metadata (4 commands)

conf metadata content-types
conf metadata search-users <query> [--limit 25]
conf metadata current-user
conf metadata space-permissions <spaceId>

Architecture

• Single runtime dependency: yargs
• Dual Confluence API support: v2 for reads, v1 for writes
• Multi-profile configuration at ~/.conf-cli/config.json
• Markdown ↔ Confluence storage format auto-conversion

License

MIT — see LICENSE.