@holydocs/cli

The official command-line tool for HolyDocs — build, preview, and deploy beautiful documentation sites.

Install

npm install -g @holydocs/cli

Also works with pnpm add -g, yarn global add, or one-shot via npx @holydocs/cli.

30-Second Start

npm install -g @holydocs/cli   # 1. install
mkdir my-docs && cd my-docs && holydocs init   # 2. scaffold docs
holydocs login && holydocs deploy              # 3. authenticate + ship

holydocs login uses a browser-based device authorization flow by default — your browser opens with a one-time code, you sign in once, and the CLI receives a write-scoped API key. In CI and other headless environments, use HOLYDOCS_API_KEY or holydocs login --api-key hd_....

After login, if you don't already have a project, the CLI offers to create one in 1–2 prompts and runs your first deployment as proof.

Headless / CI

For SSH sessions, containers, and CI pipelines:

# Print the device code without opening a browser
holydocs login --no-browser

# Skip the device flow entirely (recommended for CI)
holydocs login --api-key hd_xxxxxxxxxxxxxxxxxxxx

# Or skip login entirely in ephemeral CI
HOLYDOCS_API_KEY=hd_xxxxxxxxxxxxxxxxxxxx HOLYDOCS_PROJECT=proj_abc123 holydocs deploy --no-watch

Create API keys at app.holydocs.com/settings/api-keys.

Commands

| Command | Description | |---|---| | holydocs login | Authenticate via browser device flow | | holydocs logout | Clear stored credentials | | holydocs whoami | Show current authentication status | | holydocs init | Scaffold a new HolyDocs project | | holydocs dev | Local preview server with hot reload | | holydocs build | Build static HTML for all pages | | holydocs deploy | Deploy to HolyDocs | | holydocs status | Show deployment status | | holydocs api <method> <path> | Make authenticated API requests | | holydocs check | Validate docs.json configuration | | holydocs links | Check for broken internal links | | holydocs new <path> | Create a new documentation page | | holydocs generate <spec> | Generate API reference from OpenAPI | | holydocs openapi-check <spec> | Validate an OpenAPI specification | | holydocs migrate <platform> | Import docs from Mintlify, Docusaurus, GitBook, ReadMe, Confluence, or Notion |

Run holydocs <command> --help for command-specific options.

Configuration

Credentials are stored in ~/.holydocs/config.json.

The CLI also reads these environment variables:

• HOLYDOCS_API_KEY: override the saved API key for CI or one-off shells
• HOLYDOCS_API_URL: override the API base URL
• HOLYDOCS_PROJECT: set the default project ID for deploy / status
• HOLYDOCS_DASHBOARD_URL: change the dashboard URL shown by the onboarding wizard

Documentation

Full docs at holydocs.com/cli/overview.

License

MIT