Getting Started

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

Installation

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

Verify the installation:


acs2md --version

Activate your license

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


acs2md license activate --license-key YOUR_LICENSE_KEY

You can verify the activation at any time:


acs2md license validate

Purchase a license at climakers.com/acs2md . The license is tied to the current machine, so validate it before you begin a bulk export workflow.

Connect to Confluence

acs2md 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


acs2md config create

Open the config file


acs2md 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


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

Set credentials via environment variables

bash / zsh


export ACS2MD_CONFLUENCE_DOMAIN=mycompany.atlassian.net
export ACS2MD_CONFLUENCE_USERNAME=you@example.com
export ACS2MD_CONFLUENCE_API_TOKEN=YOUR_API_TOKEN

PowerShell


$env:ACS2MD_CONFLUENCE_DOMAIN="mycompany.atlassian.net"
$env:ACS2MD_CONFLUENCE_USERNAME="you@example.com"
$env:ACS2MD_CONFLUENCE_API_TOKEN="YOUR_API_TOKEN"

CI/CD


# GitHub Actions example
env:
  ACS2MD_CONFLUENCE_DOMAIN: mycompany.atlassian.net
  ACS2MD_CONFLUENCE_USERNAME: ${{ secrets.CONFLUENCE_USERNAME }}
  ACS2MD_CONFLUENCE_API_TOKEN: ${{ secrets.CONFLUENCE_API_TOKEN }}

Validate the workstation before the first bulk run

Run the readiness check before you begin a real space export:


acs2md doctor

This validates the installed license, configuration, machine identity, and Confluence connectivity in one step.

Discover the correct target space

Bulk workflows should start with discovery, not with conversion.


# List available spaces
acs2md space list --limit 25
 
# Review the pages in a target space
acs2md space pages by-key DOCS --limit 50
 
# Review hierarchy before converting
acs2md space pages by-key DOCS --tree

Convert your first space

Find the space key from the Confluence URL — it appears after /wiki/spaces/ and is typically a short uppercase string like DOCS or MYSPACE.


acs2md space convert by-key MYSPACE --output-dir ./docs

Not sure of the space key? List all accessible spaces first:


acs2md space list