conflumark

Export Confluence Cloud pages to Markdown.

Usage

npx conflumark [options] [pageIds...]

Options

| Option | Description | | --- | --- | | -s, --space <key> | Export all pages in a space | | -r, --recursive | Include child pages recursively | | -o, --output <dir> | Output directory (default: current directory) | | --overwrite | Overwrite existing files | | --reset-auth | Clear stored credentials | | -v, --verbose | Show detailed output | | -V, --version | Show version number | | -h, --help | Show help |

Authentication

Credentials are resolved in this order:

1. Environment variables (for CI/scripts)
2. Stored config (~/.config/conflumark/config.json)
3. Interactive prompt (first-time setup)

| Variable | Description | | --- | --- | | CONFLUENCE_URL | Confluence base URL (e.g., https://your-site.atlassian.net) | | CONFLUENCE_EMAIL | Account email | | CONFLUENCE_TOKEN | API token |

Generate an API token at https://id.atlassian.com/manage-profile/security/api-tokens

Examples

# Export specific pages
npx conflumark 12345 67890

# Export all pages in a space
npx conflumark -s MYSPACE -o ./docs

# Export a page and all its child pages
npx conflumark 12345 -r -o ./docs

# Overwrite existing files with verbose logging
npx conflumark 12345 -o ./docs --overwrite -v

# Clear stored credentials
npx conflumark --reset-auth

Requirements

Node.js >= 20.0.0

License

MIT