CLI reference
Makit commands and common options.
CLI reference
Run Makit commands from the project root as pnpm exec makit <command>.
| Command | Purpose |
|---|---|
makit init |
Scaffold a new project |
makit dev |
Start a development server |
makit build |
Build a static site |
makit preview |
Serve an already built site locally |
makit check |
Validate configuration and content |
makit clean |
Remove generated data such as .makit/ |
makit adapter generate |
Generate adapter files individually |
makit init options
# Scaffold a theme/ directory with a starter component override
pnpm exec makit init --theme
# Scaffold a collection.makit.ts-based starter
pnpm exec makit init --collections
| Option | Purpose |
|---|---|
--theme |
Add theme/header.tsx, wired up by the theme convention directory |
--collections |
Start from a collection-based layout instead of a flat one |
--locale <tag> |
Initial locale, such as en-US |
--package-manager |
npm, pnpm, yarn, or bun for the dependency install |
--skip-install |
Do not install dependencies |
--force |
Overwrite existing files |
Common options
# Remove the output directory before building
pnpm exec makit build --clean
# Treat warnings as errors
pnpm exec makit build --strict
# Use another configuration file
pnpm exec makit build --config ./makit.config.ts
In CI, run check and build --strict to find broken links and structural issues before publishing.