CLI
Every fiskil command you'll use, in one place
The fiskil CLI runs everything — scaffolding, local preview, validation, and
publishing. Run it with npx fiskil <command> (or add scripts to
package.json). npx fiskil --help prints this list any time.
| Command | What it does |
|---|---|
init [dir] | Scaffold a new docs site. |
dev | Validate, fetch API specs, and start the dev server. |
build | Validate, fetch API specs, and build for production. |
start | Serve the production build. |
validate [file] | Validate docs.json (default ./docs.json). |
schema [--check] | Write docs.config.schema.json for editor autocomplete. |
openapi fetch [--force] | Download and validate remote OpenAPI specs. |
generate | Regenerate the content collection. |
doctor | Check the project layout for common problems. |
publish | Deploy the site through the Fiskil docs platform. |
Develop
dev is what you'll run most — it validates your config, pulls any remote API
specs, and serves the site locally with hot reload:
npx fiskil devBuild & serve
Produce and serve a production build locally to check it before publishing:
npx fiskil build
npx fiskil startValidate & doctor
validate checks docs.json against the schema; doctor checks the project
layout (missing files, an empty sitemap, and other common problems):
npx fiskil validate
npx fiskil doctorPublish
Deploy the built site. See Publish for targets, tokens, and custom domains:
npx fiskil publishNext: publish
Go live, on your own domain.