confluence-cli

Confluence CLI

A powerful command-line interface for Atlassian Confluence that allows you to read, search, and manage your Confluence content from the terminal.

Features

• 📖 Read pages - Get page content in text, HTML, storage, or Markdown format
• 🔍 Search - Find pages using Confluence's powerful search
• ℹ️ Page info - Get detailed information about pages
• 🏠 List spaces - View available Confluence spaces
• ✏️ Create pages - Create new pages with support for Markdown, HTML, or Storage format
• 📝 Update pages - Update existing page content and titles

• 🗑️ Delete pages - Delete (or move to trash) pages by ID or URL
• 📎 Attachments - List, download, upload, or delete page attachments
• 🏷️ Properties - List, get, set, and delete content properties (key-value metadata)
• 💬 Comments - List, create, and delete page comments (footer or inline)
• 📦 Export - Save a page and its attachments to a local folder, or a whole page tree/space with --recursive
• 🛠️ Edit workflow - Export page content for editing and re-import

• 🔀 Profiles - Manage multiple Confluence instances with named configuration profiles
• 🔒 Read-only mode - Profile-level write protection for safe AI agent usage
• 🌐 Raw API requests - Make arbitrary authenticated requests to any Confluence endpoint (like gh api)
• 🔄 Format conversion - Convert between Markdown, HTML, Storage, and text formats locally (no server required)
• 🔧 Easy setup - Simple configuration with environment variables or interactive setup

Installation

Homebrew (macOS/Linux)

brew install pchuri/tap/confluence-cli

Homebrew 5.1.15+ warns that third-party taps are "not trusted". To trust the tap and silence the warning (required in a future Homebrew release):

brew trust pchuri/tap

npm

npm install -g confluence-cli

Or run directly with npx:

npx confluence-cli

Note: npm does not automatically install the optional typebox dependency. Loading the bundled Pi extension from an npm-installed copy requires installing typebox alongside confluence-cli; the documented local-checkout npm ci already includes it.

Pi Coding Agent: local package with protected writes

Install this local checkout into Pi without globally installing confluence. Install the clone's dependencies first because Pi does not install dependencies for local-path packages: