Installation

Install the CLI

The holydocs CLI is distributed as an npm package. Install it globally using your preferred package manager:

bash
npm install -g @holydocs/cli

bash
pnpm add -g @holydocs/cli

bash
yarn global add @holydocs/cli

bash
npx @holydocs/cli <command>

Verify Installation

After installing, verify the CLI is available:

bash
holydocs --version

You should see output like:

text
0.2.1

System Requirements

The CLI requires Node.js 20+ — the bundled binary is built with esbuild's node20 target and uses APIs available only in Node 20 and above.

Authentication

Some CLI commands (like deploy) require authentication with your HolyDocs account. Log in from the terminal:

bash
holydocs login

This opens your browser to a verification page with a one-time code pre-filled in the URL. If you're already signed into the dashboard, the page authorizes the CLI immediately. The CLI then receives a write-scoped API key (90-day expiry) and saves it to ~/.holydocs/config.json.

If your organization has zero projects when you log in, the CLI can also walk you through a quick setup wizard (1–2 questions) to create your first project. Skip it with holydocs login --no-wizard.

To check your current authentication status:

bash
holydocs whoami

To log out and remove stored credentials:

bash
holydocs logout

See the full holydocs login reference for headless flags, custom API endpoints, and the device flow internals.

CI/CD Integration

CI environments don't have a browser, so use holydocs login --api-key to skip the device flow:

bash
holydocs login --api-key $HOLYDOCS_API_KEYholydocs deploy --project <project-id>

Create API keys from the dashboard at app.holydocs.com/settings/api-keys, and store them in your CI provider's secret store. For fully ephemeral CI, you can also skip holydocs login and set HOLYDOCS_API_KEY / HOLYDOCS_PROJECT directly.

yaml
# GitHub Actions example- name: Deploy docs  run: |    holydocs login --api-key ${{ secrets.HOLYDOCS_API_KEY }}    holydocs deploy

In CI, use npx @holydocs/cli@latest instead of a global install to avoid caching issues between pipeline runs and to always get the latest published version.

Updating

To update to the latest version:

bash
npm update -g @holydocs/cli

bash
pnpm update -g @holydocs/cli

bash
yarn global upgrade @holydocs/cli

Uninstalling

To remove the CLI:

bash
npm uninstall -g @holydocs/clirm -rf ~/.holydocs

Next Steps