acp2md

acp2md stands for Atlassian Confluence Page to Markdown.

It is the focused single-page tool in the Climakers portfolio. Use it when the requirement is not “export the whole space,” but “work on this exact page with full control over scope, output, and downstream handling.”

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

Positioning: acp2md is not just a page-conversion CLI. It is a tool for giving customers control, ownership, and portability over enterprise knowledge at page level.

What it does

• Convert a page to Markdown by page ID, title, or Confluence URL
• Retrieve the same page in ADF or Storage format without converting it
• Count ADF nodes and marks and list page properties when you need page-level analysis
• Control metadata, image embedding, macro rendering, and output conflict behavior
• Refresh recurring exports efficiently with a local .convert-sync-state.json file beside the output
• Work with current, draft, archived, and historical versions of a page

Why teams use it

• Create a controlled Markdown snapshot of one important page.
• Inspect raw ADF or Storage payloads during troubleshooting or migration design.
• Export a runbook, policy, or evidence page into Git or an archive under customer control.
• Prepare one authoritative source document for RAG, search, or downstream automation.
• Support teams that work from a pasted Confluence URL rather than from a large migration plan.

How to use this manual

Read this overview first when you need to understand where acp2md fits in the Climakers toolset and which page workflow matches the job.

Then move to the command guides that match the operation you actually need:

• Getting started for the first successful run
• Configuration for connection and credential setup
• Page convert for Markdown export workflows
• Page get for native ADF or Storage retrieval
• Page count for structural ADF analysis
• Page properties for metadata inspection
• Utilities for doctor, tree, and completion

That structure keeps the overview focused on decision-making while the subpages hold the detailed command surface.

Business outcomes

Backup and retention

acp2md helps create portable copies of business-critical pages in a vendor-neutral format. That matters when a team needs page-level backup, regulated evidence retention, or a reliable export before editing, deletion, or platform changes.

Business continuity and disaster recovery

For continuity planning, a standard Markdown export is easier to replicate than a proprietary document representation. Teams can store converted pages in Git, object storage, encrypted archives, secondary regions, or internal repositories as part of broader business continuity planning.

Compliance and audit support

Because the output is plain text with optional metadata, exported pages are easier to inspect, diff, classify, archive, and review. This supports internal controls, audit evidence preparation, legal hold procedures, and records governance.

RAG and LLM readiness

Confluence content is valuable, but not always directly usable by retrieval systems. acp2md converts pages into a format that is easier to chunk, embed, index, and enrich for internal search, question-answering, and knowledge assistant workflows.

Data sovereignty and clear-text ownership

Markdown is clear text by design. In this context, that is a feature.

• Your exported knowledge is no longer locked inside a proprietary editor format.
• You decide where the resulting files live: local disk, internal Git, approved cloud storage, regional object storage, backup vaults, or offline archives.
• You can apply your own controls around that content, including encryption at rest, access control, retention rules, DLP, object lock, legal hold, and regional residency requirements.
• You can inspect the content with standard tools without depending on one platform to read your own documentation.

Read-only by design: acp2md only reads from Confluence. It never creates, modifies, or deletes any page, space, property, permission, or other resource in your Confluence instance. All API calls are read-only GET requests.

First successful run

The standard first run is deliberately simple:

1. activate the license
2. configure Confluence access
3. run acp2md doctor
4. discover the space with acp2md space list
5. confirm the scope with acp2md space pages by-key DOCS --limit 25
6. export one page with acp2md page convert by-id 123456 -o ./page.md

That gives you a clean operator path from environment validation to the first portable Markdown output.

Recommended operator flow

1. activate the license
2. configure Confluence access
3. run acp2md doctor
4. discover the correct space and page with space list and space pages
5. use tree --short when you want a compact command inventory before a customer-facing run
6. choose the right page command: convert, get, count, or properties

Choosing the right page command

Use page convert when

• you want readable Markdown output
• you want to store a page in Git, object storage, or a content pipeline
• you are preparing content for static sites, RAG, audits, or long-term retention

Use page get when

• you want native Confluence content instead of Markdown
• you need atlas_doc_format for engineering or migration analysis
• you need storage output for debugging or custom transformation work

Use page count when

• you want to estimate page complexity before migration
• you want to inspect formatting richness before AI ingestion or publishing
• you need a fast structural profile of headings, tables, lists, marks, or macros

Use page properties when

• you need page metadata rather than content
• you are investigating app-added properties, migration state, or governance metadata

Choose the input form deliberately

• by-id is the most deterministic choice when you already know the exact page.
• by-title is useful when the title is known but the page ID is not.
• by-url is the fastest option when support, compliance, or engineering teams are sharing browser links directly.

Shared operator utilities

acp2md also includes the supporting commands teams need around the export itself:

• doctor for environment validation
• tree --short for fast command discovery before a runbook or demo
• completion for shell completion setup
• config where for locating the active config file

Typical use cases

Companion tool

For bulk operations across an entire space, see acs2md — the space converter.