Skip to content

CLI ​

The Slide Spec CLI handles everything from project setup to building your final site.

Requires: Node.js 24+

Typical workflow: init → edit YAML → validate → fetch (optional) → build or serve

Running the CLI ​

bash
npx @slide-spec/cli

Running without arguments starts the interactive mode, which walks you through project setup. This is the same as running npx @slide-spec/cli init without arguments. If you prefer declarative flags, see the init documentation.

Project root ​

By default, all commands use your current working directory. To target a different directory, pass it as the first argument:

bash
npx @slide-spec/cli validate ./my-slides

Or use the --project-root flag:

bash
npx @slide-spec/cli validate --project-root ./my-slides

Global options ​

FlagDescription
--log-path <file>Write sanitized logs to a file
--help, -hShow usage. help <command> for subcommand help