CLI Usage

The CLI entry point is shevky, provided by @shevky/core via its bin field in package.json.

Running Commands

Always use npx from the project root:

npx shevky <flag>

Or use the npm scripts added by --init:

npm run build   # equivalent to: npx shevky --build
npm run dev     # equivalent to: npx shevky --dev

Available Commands

Help

npx shevky --help

Shows all available options and project links.

Version

npx shevky --version

Prints the Shevky version string.

Initialize Project

npx shevky --init

Bootstraps a starter project: clones template files, installs dependencies, updates package.json scripts.

Build

npx shevky --build

Runs the full static site build: loads config, compiles templates, loads content, runs plugin hooks, renders pages, writes output to dist/.

Dev

npx shevky --dev

Runs the full build first, then starts a local static server at http://localhost:3000 using serve@14.

Default Behavior

If no flag is provided, the CLI prints the help text.

Note on Watch Mode

A runWatch() function exists in core/scripts/main.js but is not exposed as a CLI flag in the current version. (Inferred from source comparison between main.js and cli.js.)

Related