Hyperdocs

CLI Reference

Complete reference for all hyperdocs CLI commands.

hyperdocs init

Initialises a new Hyperdocs project in the current directory, creating hyperdocs.config.ts.

bash
hyperdocs init [--name <name>] [--template <template>]

hyperdocs generate

Runs the AI generation pipeline against your source code and writes output to the local project store.

bash
hyperdocs generate [--watch] [--only <glob>]

hyperdocs deploy

Publishes your local project to the Hyperdocs CDN.

bash
hyperdocs deploy [--env <env>] [--dry-run]

hyperdocs dev

Starts a local preview server at http://localhost:4000.

bash
hyperdocs dev [--port <port>]