CLI

The doc-kit command-line interface. Every option that maps to configuration can also live in a configuration file; when both are present, CLI flags win (rule of specifity).

npx @doc-kit/cli [command] [options]

One option applies to every command:

• --log-level <level> string debug, info, warn, error, or fatal. Default: 'info'.

npx @doc-kit/cli generate [options]

Runs the generators and writes their output. Requires a target and an input, from flags or the configuration file.

• --config-file <path> string Use a specific configuration file instead of searching.
• -i, --input <patterns...> string[] Input file patterns (glob).
• -t, --target <name...> string[] Generator name(s), or import specifiers for custom generators.
• --ignore <patterns...> string[] Input patterns to skip.
• -o, --output <dir> string The output directory.
• -v, --version <semver> string The version of the project being documented.
• -c, --changelog <url> string Changelog URL or path (release history for version selectors).
• --git-ref <ref> string Git ref used in source links.
• --index <url> string index.md URL or path.
• --minify boolean Minify the output.
• --type-map <url> string Type map URL or path (custom type-name → URL links).
• -p, --threads <n> number Worker threads to use (minimum 1).
• --chunk-size <n> number Items per worker thread (minimum 1).

npx @doc-kit/cli preview [options]

Serves the generated docs over HTTP for local verification. Every generate option is accepted: when any of them is passed, the docs are built first (same semantics as doc-kit generate); otherwise the existing output directory is served as-is (./out by default).

Note: The preview server is meant for local testing only — it is not production grade. Do not use it to deploy your documentation.

• --port <n> number Port to serve on. Default: 3000.
• --host <host> string Host to listen on (e.g. localhost, 0.0.0.0). Default: 'localhost'.
• Every option of doc-kit generate.