Skip to Content

Utilities

This page documents the top-level commands currently exposed by acp2md tree, plus the utility commands used for diagnostics and discovery.

These commands matter because they shape the safe operator workflow around the product. In production and support use, they should be part of the runbook, not an afterthought.

Top-level commands

  • config — manage application configuration. See Config Commands.
  • completion — generate shell completion scripts for supported shells. Documented below.
  • doctor — verify configuration, credentials, and connectivity. Documented below.
  • license — manage your license. See License.
  • page — work with individual Confluence pages. See Convert Pages, Get Pages, Count & Analyze, and Page Properties.
  • tree — display the full command tree with descriptions. Documented below.

doctor

acp2md doctor [flags]

Runs a series of diagnostic checks to verify that acp2md is correctly configured and ready to use. This is the fastest way to diagnose setup issues.

The following checks are performed:

CheckDescription
Config fileVerifies the configuration file exists and is readable
Confluence credentialsConfirms that domain, username, and API token are set
API connectivityTests the connection to the Confluence REST API
License fileChecks that a valid license is present
Machine IDVerifies the machine identifier used for license binding
Version infoDisplays the current acp2md version, build date, and commit

Example

acp2md doctor

Run acp2md doctor as a first step when troubleshooting any issue. The output will indicate which component needs attention.

Recommended moments to run doctor:

  • immediately after license activation
  • after changing credentials or proxy configuration
  • before the first export on a new machine
  • before a customer-facing or time-sensitive run

completion

acp2md completion [bash|zsh|fish|powershell]

Generates shell completion scripts so operators can discover commands and flags faster from the terminal.

Examples

acp2md completion zsh acp2md completion bash

Use completion when you want a smoother local operator experience, especially for longer subcommand paths and repeated support or operations work.


tree

acp2md tree [flags]

Displays the full command tree with descriptions. This is a quick way to discover all available commands and subcommands without reading the full documentation.

Flags

FlagShortDefaultDescription
--short-sfalseHide flags and show only commands with descriptions

Example

acp2md tree acp2md tree --short

Sample output

acp2md ├── completion Generate shell completion scripts ├── config Manage application configuration ├── doctor Verify configuration, credentials, and connectivity ├── license Manage your license ├── page Work with individual Confluence pages └── tree Display the full command tree with descriptions

Use tree --short when you want a compact release inventory for operators, onboarding notes, or internal runbooks.

Last updated on