Confluence Markdown Exporter

https://spenhouet.github.io/confluence-markdown-exporter/
Admin
A CLI tool that exports Confluence pages to Markdown format with support for multiple targets...
Tokens:1,090
Snippets:21
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install CLI via curl (Linux/macOS)

Source: https://spenhouet.github.io/confluence-markdown-exporter

Installs an isolated, self-updating CLI using uv. This is a one-command installation for Linux and macOS.

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

--------------------------------

### Install and run with uv

Source: https://spenhouet.github.io/confluence-markdown-exporter

Installs the CLI as an isolated tool using uv or runs it once without installation using uvx. This provides flexibility in managing the tool.

```bash
# Install as an isolated tool…
uv tool install confluence-markdown-exporter

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

--------------------------------

### Docker Installation and Usage

Source: https://spenhouet.github.io/confluence-markdown-exporter

Pulls the prebuilt Docker image and demonstrates how to run the exporter with the --help flag. Suitable for non-interactive or CI environments.

```bash
# Pull and run the prebuilt image (non-interactive / CI use).
docker pull spenhouet/confluence-markdown-exporter:latest
docker run --rm spenhouet/confluence-markdown-exporter --help
```

--------------------------------

### Install via pip

Source: https://spenhouet.github.io/confluence-markdown-exporter

Installs the confluence-markdown-exporter package using pip. This method is suitable for environments where pip is already managed.

```bash
pip install confluence-markdown-exporter
```

--------------------------------

### Install CLI via PowerShell (Windows)

Source: https://spenhouet.github.io/confluence-markdown-exporter

Installs an isolated, self-updating CLI using uv on Windows via PowerShell. Ensure your ExecutionPolicy allows script execution.

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

--------------------------------

### Generate Authentication JSON on Workstation

Source: https://spenhouet.github.io/confluence-markdown-exporter

Writes the authentication configuration to `app_data.json` in the user's config directory. This file can then be copied to CI environments or secret stores.

```bash
# Writes ~/.config/confluence-markdown-exporter/app_data.json
cme config edit auth.confluence
```

--------------------------------

### Edit Authentication Configuration

Source: https://spenhouet.github.io/confluence-markdown-exporter

Opens the authentication configuration file for Confluence. This command is used across different platforms (Linux, macOS, Windows, pip, uv, Docker) to set up authentication.

```bash
cme config edit auth.confluence
```

--------------------------------

### Docker Export Command

Source: https://spenhouet.github.io/confluence-markdown-exporter

Runs the Confluence Markdown Exporter within a Docker container, mounting the local configuration and output directories. This is useful for CI/CD pipelines.

```bash
docker run --rm \
  -v "$PWD/app_data.json:/data/config/app_data.json:ro" \
  -v "$PWD/output:/data/output" \
  spenhouet/confluence-markdown-exporter \
  pages https://example.atlassian.net/wiki/spaces/SPACE/pages/123/Title
```

--------------------------------

### Export a Confluence Page

Source: https://spenhouet.github.io/confluence-markdown-exporter

Exports a single Confluence page to Markdown. Replace the URL with your specific page URL.

```bash
# A page, a subtree, an entire space, or every space of an org:
cme pages   https://example.atlassian.net/wiki/spaces/SPACE/pages/123/Title
cme spaces  https://example.atlassian.net/wiki/spaces/SPACE
cme orgs    https://example.atlassian.net
```
Tokens:
Raw