Installation

Pick the install method that fits your environment. All methods produce the same cme / confluence-markdown-exporter CLI.

Linux

curl -LsSf uvx.sh/confluence-markdown-exporter/install.sh | sh

Uses uv under the hood to create an isolated, self-updating environment. No need to manage a virtualenv yourself.

macOS

curl -LsSf uvx.sh/confluence-markdown-exporter/install.sh | sh

Uses uv under the hood to create an isolated, self-updating environment. No need to manage a virtualenv yourself.

Windows

powershell -ExecutionPolicy ByPass -c "irm https://uvx.sh/confluence-markdown-exporter/install.ps1 | iex"

Uses uv under the hood. Run from PowerShell.

pip

pip install confluence-markdown-exporter

Installs from PyPI into the active Python environment. Requires Python ≥ 3.10. If you don't already have a project virtualenv, prefer the uv or Linux/macOS/Windows installer tabs; they isolate the tool for you.

uv

# Install as an isolated, self-managed tool
uv tool install confluence-markdown-exporter

# …or run it once without installing
uvx confluence-markdown-exporter --help

uv tool install puts the CLI on your PATH inside its own isolated environment. uvx runs it ephemerally; handy for one-off exports or CI.

Docker

docker pull spenhouet/confluence-markdown-exporter:latest
docker run --rm spenhouet/confluence-markdown-exporter --help

The Docker image is intended for non-interactive / CI use: you supply a pre-defined config (mounted JSON file or env vars) and the container runs a single export command and exits. The interactive cme config menu is not available inside the container. Full setup (mounted config, Compose example, env-var auth) is on the Docker page.

Pinning a specific version

Linux

curl -LsSf uvx.sh/confluence-markdown-exporter/5.1.1/install.sh | sh

macOS

curl -LsSf uvx.sh/confluence-markdown-exporter/5.1.1/install.sh | sh

Windows

powershell -ExecutionPolicy ByPass -c "irm https://uvx.sh/confluence-markdown-exporter/5.1.1/install.ps1 | iex"

pip

pip install confluence-markdown-exporter==5.1.1

uv

uv tool install confluence-markdown-exporter==5.1.1

Docker

docker pull spenhouet/confluence-markdown-exporter:5.1.1

Pinned tags are kept available indefinitely; rolling tags (latest, <major>, <major>.<minor>) advance with each release. See Docker → Available tags.

Verify the install

Linux

cme --help

macOS

cme --help

Windows

cme --help

pip

cme --help

uv

cme --help

Docker

docker run --rm spenhouet/confluence-markdown-exporter --help

You should see the top-level commands: pages, pages-with-descendants, spaces, orgs, and config.

Next steps

• Authenticate and configure your first export → (local install)
• Export pages or whole spaces → (local install)
• Docker page: non-interactive setup (mounted config + env vars)