Getting Started

acp2md supports Atlassian Confluence Cloud only. It does not support Confluence Server or Confluence Data Center.

Installation

Install the latest acp2md package or binary for your platform and place it on your PATH.

Verify the installation:


acp2md --version

This should be the first confirmation that the binary is installed correctly before you configure credentials or activate the license.

Activate your license

acp2md requires a valid license. Activate it once with your license key:


acp2md license activate --license-key YOUR_LICENSE_KEY

You can verify the activation at any time:


acp2md license validate

Purchase a license at climakers.com/acp2md . The license is tied to the current machine, so validate it before your first operational run.

Connect to Confluence

acp2md needs three credentials to talk to your Confluence instance:

Credential	Description
`confluence.domain`	Your Confluence domain, e.g. `mycompany.atlassian.net`
`confluence.username`	Your Atlassian account email
`confluence.api_token`	A Confluence API token

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

Set credentials via config file (recommended)

Create the default config file


acp2md config create

Open the config file


acp2md config where

This prints the path to the config file. Open it in any text editor.

Add your credentials


confluence:
  domain: mycompany.atlassian.net
  username: you@example.com
  api_token: YOUR_API_TOKEN

Set credentials via CLI


acp2md config set confluence.domain mycompany.atlassian.net
acp2md config set confluence.username you@example.com
acp2md config set confluence.api_token YOUR_API_TOKEN

Set credentials via environment variables

bash / zsh


export ACP2MD_CONFLUENCE_DOMAIN=mycompany.atlassian.net
export ACP2MD_CONFLUENCE_USERNAME=you@example.com
export ACP2MD_CONFLUENCE_API_TOKEN=YOUR_API_TOKEN

PowerShell


$env:ACP2MD_CONFLUENCE_DOMAIN="mycompany.atlassian.net"
$env:ACP2MD_CONFLUENCE_USERNAME="you@example.com"
$env:ACP2MD_CONFLUENCE_API_TOKEN="YOUR_API_TOKEN"

CI/CD


env:
  ACP2MD_CONFLUENCE_DOMAIN: mycompany.atlassian.net
  ACP2MD_CONFLUENCE_USERNAME: ${{ secrets.CONFLUENCE_USERNAME }}
  ACP2MD_CONFLUENCE_API_TOKEN: ${{ secrets.CONFLUENCE_API_TOKEN }}

Validate the workstation before the first export

Run the readiness check before you target a real page:


acp2md doctor

This confirms the installed license, configuration, machine identity, and Confluence connectivity in one step. It is the fastest way to find setup problems before you start exporting customer content.

Discover the correct page safely

When teams jump directly into a conversion command, the most common error is targeting the wrong space or the wrong page. Use discovery commands first.


# List available spaces
acp2md space list --limit 25
 
# List pages in a known space
acp2md space pages by-key DOCS --limit 50
 
# Show hierarchy when page location matters
acp2md space pages by-key DOCS --tree

Convert your first page

Find the page ID from the Confluence URL — it is the number in /pages/123456/.


acp2md page convert by-id 123456 --output my-page.md

You can also convert by title:


acp2md page convert by-title "My Page Title" --output my-page.md

If you already have a browser URL, you can skip the manual page ID lookup:


acp2md page convert by-url "https://mycompany.atlassian.net/wiki/spaces/ENG/pages/123456/My+Page" --output my-page.md