Confluence Markdown Exporter

https://spenhouet.com/confluence-markdown-exporter/
Admin
Confluence Markdown Exporter is a CLI tool that exports Confluence spaces, subtrees, or pages into...
Tokens:6,229
Snippets:106
Trust Score:6.4
Update:2 months ago
Show doc for...
Tokens:
Raw
### Verify installation

Source: https://spenhouet.com/confluence-markdown-exporter/installation

Checks that the CLI is correctly installed and accessible.

```bash
cme --help
```

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

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

### Install or run via uv

Source: https://spenhouet.com/confluence-markdown-exporter/installation

Installs the tool in an isolated environment or runs it ephemerally without installation.

```bash
uv tool install confluence-markdown-exporter

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

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

### Manage documentation toolchain

Source: https://spenhouet.com/confluence-markdown-exporter/contributing

Commands for installing dependencies, previewing the site locally, and building for production.

```bash
uv sync --group docs
```

```bash
uv run zensical serve
```

```bash
uv run zensical build --strict
```

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

### Install confluence-markdown-exporter

Source: https://spenhouet.com/confluence-markdown-exporter/intro

Commands to install the CLI tool across different environments.

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

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

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

```bash
uv tool install confluence-markdown-exporter
# or, one-shot run without installing:
uvx confluence-markdown-exporter --help
```

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

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

### Install via shell script

Source: https://spenhouet.com/confluence-markdown-exporter/installation

Uses uv to create an isolated, self-updating environment for Linux/macOS or Windows.

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

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

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

### Install Confluence Markdown Exporter

Source: https://spenhouet.com/confluence-markdown-exporter

Installation commands for various environments including Linux, macOS, Windows, and Docker.

```bash
# Installs an isolated, self-updating CLI via uv.
curl -LsSf uvx.sh/confluence-markdown-exporter/install.sh | sh
```

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

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

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

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

```bash
# Prebuilt image, for 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.com/confluence-markdown-exporter/installation

Installs the package from PyPI into the active Python environment. Requires Python 3.10 or higher.

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

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

### View output directory structure

Source: https://spenhouet.com/confluence-markdown-exporter/usage

Example of the directory hierarchy generated by the exporter based on the configured output path.

```text
output_path/
└── MYSPACE/
   ├── MYSPACE.md
   └── MYSPACE/
      ├── My Confluence Page.md
      └── My Confluence Page/
            ├── My nested Confluence Page.md
            └── Another one.md
```

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

### Example Front Matter with Metadata

Source: https://spenhouet.com/confluence-markdown-exporter/configuration/options

Shows the resulting YAML front matter when both URL inclusion and page metadata features are enabled.

```yaml
---
tags:
  - team-foo
confluence_webui_url: https://.../wiki/spaces/.../pages/123/Title
confluence_page_id: '123'
confluence_space_key: TEAM
confluence_type: page
confluence_created: "2024-08-15T08:34:12.000+02:00"
confluence_created_by: Sam Creator
confluence_last_modified: "2026-04-12T10:34:00.000+02:00"
confluence_last_modified_by: Alex Johnson
confluence_version: 7
---
```

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

### Pin a specific version

Source: https://spenhouet.com/confluence-markdown-exporter/installation

Installs or pulls a specific version of the tool.

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

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

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

```bash
uv tool install confluence-markdown-exporter==5.3.0
```

```bash
docker pull spenhouet/confluence-markdown-exporter:5.3.0
```

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

### Render Image Captions Example

Source: https://spenhouet.com/confluence-markdown-exporter/configuration/options

Example of how image captions are rendered in Markdown when export.image_captions is enabled.

```markdown
![](image.png)
_Caption text_

```

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

### Example sidecar file for comments_export

Source: https://spenhouet.com/confluence-markdown-exporter/configuration/options

Shows the structure of a generated .comments.md sidecar file when comments_export is set to 'all'.

```markdown
---
confluence_page_id: '123'
confluence_page_title: "Example Page"
confluence_webui_url: "https://example.atlassian.net/wiki/spaces/TEAM/pages/123"
---

## Inline comments

### marked excerpt
> marked excerpt

**Alice** · 2026-04-01

Looks good to me.

## Page comments

### Discussion about the rollout

**Bob** · 2026-04-02

Are we shipping this Friday?
```

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

### List Current Configuration

Source: https://spenhouet.com/confluence-markdown-exporter/configuration

Displays the full configuration in YAML or JSON format.

```bash
cme config list           # YAML (default)
cme config list -o json   # JSON
```

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

### Open Interactive Configuration Menu

Source: https://spenhouet.com/confluence-markdown-exporter/configuration

Launches the interactive menu to view, modify, or reset configuration options.

```bash
cme config
```

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

### Display Configuration File Path

Source: https://spenhouet.com/confluence-markdown-exporter/configuration

Outputs the absolute path to the current configuration file.

```bash
cme config path
```

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

### Configure via Docker Compose

Source: https://spenhouet.com/confluence-markdown-exporter/docker

Use a declarative approach to mount configuration and volumes using Docker Compose.

```yaml
services:
  cme:
    image: spenhouet/confluence-markdown-exporter:latest
    command: ["pages", "<page-url>"]
    configs:
      - source: cme_config
        target: /data/config/app_data.json
    volumes:
      - ./output:/data/output

configs:
  cme_config:
    file: ./app_data.json
```

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

### Configure authentication interactively

Source: https://spenhouet.com/confluence-markdown-exporter/configuration/authentication

Use these commands to open the interactive menu for setting Confluence and Jira credentials.

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

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

### Run container with mounted configuration

Source: https://spenhouet.com/confluence-markdown-exporter/docker

Mount a local JSON configuration file and an output directory to run an export command.

```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 <page-url>
```

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

### Inject authentication credentials via environment variables

Source: https://spenhouet.com/confluence-markdown-exporter/docker

Supply authentication dictionaries as JSON-encoded strings when environment variables are required for secrets.

```bash
docker run --rm \
  -v "$PWD/app_data.json:/data/config/app_data.json:ro" \
  -e CME_AUTH__CONFLUENCE="{\"https://company.atlassian.net\":{\"username\":\"$CONFLUENCE_USER\",\"api_token\":\"$CONFLUENCE_API_TOKEN\"}}" \
  -v "$PWD/output:/data/output" \
  spenhouet/confluence-markdown-exporter \
  pages <page-url>
```

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

### Retrieve Single Configuration Value

Source: https://spenhouet.com/confluence-markdown-exporter/configuration

Prints the value of a specific configuration key.

```bash
cme config get export.log_level
cme config get connection_config.max_workers
```

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

### Configure Obsidian export settings

Source: https://spenhouet.com/confluence-markdown-exporter/configuration/target-systems

Sets export parameters to optimize output for Obsidian, including wiki-style links and specific metadata formats.

```bash
cme config set \
  export.include_document_title=false \
  export.page_breadcrumbs=false \
  export.page_href=wiki \
  export.attachment_href=wiki \
  export.page_properties_format=meta-bind-view-fields \
  export.page_properties_report_format=dataview
```

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

### Set Configuration Values

Source: https://spenhouet.com/confluence-markdown-exporter/configuration

Updates one or more configuration keys using key=value pairs.

```bash
cme config set export.log_level=DEBUG
cme config set export.output_path=/tmp/export
cme config set export.skip_unchanged=false
```

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

### Reset Configuration to Defaults

Source: https://spenhouet.com/confluence-markdown-exporter/configuration

Restores all settings to factory defaults, with an optional flag to skip confirmation.

```bash
cme config reset
cme config reset --yes   # skip confirmation
```

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

### Authenticate with Confluence

Source: https://spenhouet.com/confluence-markdown-exporter

Command to open the interactive configuration editor for authentication settings.

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

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

### Configure Azure DevOps (ADO) Wikis export settings

Source: https://spenhouet.com/confluence-markdown-exporter/configuration/target-systems

Configures the exporter for ADO Wikis by setting attachment paths, filename sanitization, and length limits.

```bash
cme config set \
  export.attachment_href=absolute \
  'export.attachment_path=.attachments/{attachment_file_id}{attachment_extension}' \
  'export.filename_encoding={" ":"-","\"":"%22","*":"%2A","-":"%2D",":":"%3A","<":"%3C",">":"%3E","?":"%3F","|":"%7C","\\":"_","#":"_","/":"_","":"_"}' \
  export.filename_length=200
```

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

### Configure debug logging

Source: https://spenhouet.com/confluence-markdown-exporter/contributing

Enable debug-level logging to capture full output for issue reporting.

```bash
cme config set export.log_level=DEBUG
```

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

### Run via Docker

Source: https://spenhouet.com/confluence-markdown-exporter/installation

Pulls and runs the container image for non-interactive or CI environments.

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

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

### Override settings with environment variables

Source: https://spenhouet.com/confluence-markdown-exporter/docker

Use the CME_ prefix and double underscore delimiter to override scalar configuration settings at runtime.

```bash
docker run --rm \
  -e CME_EXPORT__LOG_LEVEL=DEBUG \
  -e CME_CONNECTION_CONFIG__MAX_WORKERS=5 \
  -v "$PWD/app_data.json:/data/config/app_data.json:ro" \
  -v "$PWD/output:/data/output" \
  spenhouet/confluence-markdown-exporter \
  pages <page-url>
```

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

### Configure attachment path format

Source: https://spenhouet.com/confluence-markdown-exporter/troubleshooting

Use this command to set a custom attachment path template using human-readable filenames instead of numeric IDs.

```bash
cme config set export.attachment_path='{space_name}/attachments/{attachment_title}{attachment_extension}'
```

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

### Edit Specific Key Interactively

Source: https://spenhouet.com/confluence-markdown-exporter/configuration

Opens the interactive editor for a specific configuration section.

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

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

### Authenticate with Confluence

Source: https://spenhouet.com/confluence-markdown-exporter/intro

Commands to configure authentication credentials for the exporter.

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

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

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

### Export organization spaces

Source: https://spenhouet.com/confluence-markdown-exporter/usage

Export all pages across all spaces associated with one or more organization base URLs.

```bash
cme orgs <base-url>
cme orgs <base-url-1> <base-url-2> ...

# Singular alias (identical behaviour):
cme org <base-url>
```

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

### Control log verbosity in CI

Source: https://spenhouet.com/confluence-markdown-exporter/configuration/ci

Adjust log levels using environment variables or configuration commands to manage output detail during execution.

```bash
# Enable verbose debug logging for a single run (not persisted):
CME_EXPORT__LOG_LEVEL=DEBUG cme pages <page-url>

# Reduce verbosity permanently:
cme config set export.log_level=WARNING

# Or for the current session only:
CME_EXPORT__LOG_LEVEL=WARNING cme pages <page-url>
```

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

### Override Configuration File Path

Source: https://spenhouet.com/confluence-markdown-exporter/configuration

Sets the CME_CONFIG_PATH environment variable to point to a custom configuration file.

```bash
export CME_CONFIG_PATH=/path/to/your/custom_config.json
```

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

### Export pages with descendants

Source: https://spenhouet.com/confluence-markdown-exporter/usage

Export a page and all its nested child pages.

```bash
cme pages-with-descendants <page-url>
cme pages-with-descendants <page-url-1> <page-url-2> ...

# Singular alias (identical behaviour):
cme page-with-descendants <page-url>
```

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

### Export Confluence Content

Source: https://spenhouet.com/confluence-markdown-exporter

Commands to export pages, spaces, or entire organizations to Markdown.

```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
```

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

### Export Confluence pages

Source: https://spenhouet.com/confluence-markdown-exporter/usage

Export one or more specific pages using their URLs. Singular aliases are available for all commands.

```bash
cme pages <page-url>
cme pages <page-url-1> <page-url-2> ...

# Singular alias (identical behaviour):
cme page <page-url>
```

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

### Export Confluence content

Source: https://spenhouet.com/confluence-markdown-exporter/intro

Commands to export pages, spaces, or organizations to Markdown.

```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
```

```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 Confluence spaces

Source: https://spenhouet.com/confluence-markdown-exporter/usage

Export all pages contained within one or more specified spaces.

```bash
cme spaces <space-url>
cme spaces <space-url-1> <space-url-2> ...

# Singular alias (identical behaviour):
cme space <space-url>
```

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

### Required API token scopes

Source: https://spenhouet.com/confluence-markdown-exporter/configuration/authentication

List of classic scopes required for scoped API tokens to ensure full read-only access.

```text
read:confluence-content.all
read:account
read:confluence-content.permission
read:confluence-content.summary
read:confluence-groups
read:confluence-props
read:confluence-space.summary
read:confluence-user
read:me
readonly:content.attachment:confluence
search:confluence
```
Tokens:
Raw