Skip to Content

Utilities

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

These commands frame the safe operator workflow for bulk export: validate the workstation, inspect the command surface, and confirm the target before you run a consequential job.

Top-level commands


Doctor

acs2md doctor [flags]

Runs a series of diagnostic checks and reports the results. Use this to verify your setup before running a conversion.

Checks performed

CheckDescription
ConfigVerifies that a configuration file exists and is valid
CredentialsConfirms that Confluence domain, username, and API token are set
API connectivityTests a live connection to the Confluence REST API
LicenseValidates the current license status
Machine IDVerifies that a stable machine identifier can be generated
VersionDisplays the current acs2md version, build date, and commit

Examples

# Run all diagnostic checks acs2md doctor # Aliases work the same way acs2md check acs2md diag

Recommended moments to run doctor:

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

completion

acs2md completion [bash|zsh|fish|powershell]

Generates shell completion scripts so operators can move through the large command surface faster.

Examples

acs2md completion zsh acs2md completion bash

Completion is especially useful for teams that rely on space and page subcommands regularly and want faster discovery from the shell.


Tree

acs2md tree [flags]

Prints the full command tree with descriptions. Useful for discovering available commands and their hierarchy.

Flags

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

Examples

# Show the full command tree acs2md tree # Hide flags and show only commands acs2md tree --short

Sample output

acs2md ├── 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 ├── space Work with Confluence spaces └── tree Display the full command tree with descriptions

Use tree --short when you need a compact release inventory for runbooks, onboarding, or internal operator documentation.

Last updated on