conflux

A fast CLI for searching and browsing Confluence from your terminal.

Installation

pip install conflux

Or with uv:

uv tool install conflux

Configuration

Run the interactive setup wizard once:

conflux init

This walks you through three prompts (Confluence URL, email, API token) and saves everything to ~/.conflux/config.toml with permissions 600. On all subsequent runs conflux reads that file automatically — no flags or environment variables needed.

You can also override any value at runtime via options or environment variables:

Variable	Description
CONFLUENCE_BASE_URL	Base URL, e.g. https://myorg.atlassian.net
CONFLUENCE_EMAIL	Your Atlassian account email
CONFLUENCE_API_TOKEN	API token from https://id.atlassian.com/manage-profile/security/api-tokens

Usage

# One-time setup
conflux init

# Plain-text search (uses saved config)
conflux search "deploy pipeline"

# CQL expression
conflux search "type=page AND space=ENG AND text~'kubernetes'"

# Limit results
conflux search "onboarding" --limit 10

Development

git clone https://github.com/<you>/conflux
cd conflux
uv sync
uv run conflux --help