Quickstart / CLI

Go from a clean terminal to verified Markdown.

The CLI handles browser OAuth, local credential storage, upload checksums, polling, and artifact integrity checks.

Install and authenticate

Interactive OAuth stores a revocable token using the operating system credential boundary. CI may use a scoped GETMD_API_KEY.

Terminalsh
npm install --global getmd
getmd auth login
getmd doctor --json

Convert original text

The default flow waits for completion and writes the verified first output to stdout.

Terminalsh
printf '%s' 'The Acorn API v2 adds cursor pagination.' | \
  getmd convert --stdin --profile agent_context --retention temporary --output acorn-context.md

Automate explicitly

Use --json for machine-readable stdout and --no-wait when another process owns polling.

Terminalsh
getmd --json convert --url https://example.com/owned-source --no-wait
getmd --json jobs status JOB_ID