Getting Started

This page is the shared operational entry point for the public Climakers manuals.

If you are evaluating the tools, use it to understand the install and setup model. If you are already licensed, use it as the fastest path to a first successful run.

Compatibility: the active Atlassian Confluence manuals cover Atlassian Confluence Cloud only. They do not support Confluence Server or Confluence Data Center.

1. Choose the right scope first

Choose acp2md when the job is one exact page.
Choose acs2md when the job is one full Confluence space.
Read acp2md vs acs2md if both appear to fit.

2. Prepare the required inputs

For the active Atlassian Confluence tools, you need:

A valid commercial license for the tool you want to run.
A Confluence Cloud domain such as mycompany.atlassian.net.
A Confluence account with read access to the target page or space.
An Atlassian API token for that account.

3. Install the binary for your platform

Install the correct binary or package for your platform, place it on your PATH, then verify the installation.


acp2md --version
acs2md --version

For platform-specific installation details, see the tool-specific guides:

4. Activate the license

Each tool is licensed separately.


acp2md license activate --license-key YOUR_LICENSE_KEY
acs2md license activate --license-key YOUR_LICENSE_KEY

Validate the installed entitlement before running exports:


acp2md license validate
acs2md license validate

5. Configure Confluence access

Both tools use the same connection model and nearly the same configuration workflow.


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

Use the equivalent acs2md config set ... commands when you are working with the space-level tool.

If you prefer environment variables for CI or managed workstations, see the dedicated Configuration pages for each tool.

6. Run the readiness check before the first export

doctor is the fastest way to catch setup problems before you start operating on customer content.


acp2md doctor
acs2md doctor

Expected outcomes:

configuration is readable
credentials are present
license state is valid
Confluence API connectivity succeeds

7. Discover the correct target

Use discovery commands before exporting anything.


# Discover spaces
acp2md space list --limit 25
acs2md space list --limit 25
 
# Browse pages inside a target space
acp2md space pages by-key DOCS --limit 50
acs2md space pages by-key DOCS --tree

This step matters because it reduces operator error before a customer-facing export, continuity run, or migration job.

8. Run the first successful export

Single-page workflow:


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

Full-space workflow:


acs2md space convert by-key DOCS --output-dir ./docs-export

9. Continue into the full manuals

After the first successful run, move into the pages that match the job you actually need to operationalize.