API
create-rezi
create-rezi is the CLI package that scaffolds new Rezi apps.
create-rezi is the CLI package that scaffolds new Rezi apps.
Usage
npm create rezi my-app
# or
bun create rezi my-appEquivalent direct invocation:
npx create-rezi my-app
# or
bunx create-rezi my-appThe CLI prompts for any missing values (project name/template) when run interactively.
Templates
Canonical template names:
dashboard(alias:dash)stress-test(aliases:stress,chaos,bench)cli-tool(aliases:cli,tool,multiscreen)minimal(aliases:mini,basic,utility)
Use a specific template:
npm create rezi my-app -- --template dashboard
npm create rezi my-app -- --template cli-tool
npm create rezi my-app -- --template minimal
# Bun
bun create rezi my-app -- --template dashboard
bun create rezi my-app -- --template cli-tool
bun create rezi my-app -- --template minimalList templates and highlights:
npm create rezi -- --list-templates
# or
bun create rezi -- --list-templatesFor full template descriptions and highlights, use: Getting Started -> Create Rezi.
Options
--template, -t <name>: Select a template (dashboard,stress-test,cli-tool,minimal, plus aliases).--no-install, --skip-install: Skip dependency installation.--pm, --package-manager <npm|pnpm|yarn|bun>: Choose a package manager.--list-templates, --templates: Print available templates and highlights.--help, -h: Show help.
Template Smoke Check
Run deterministic template smoke checks (metadata consistency + build/typecheck + test scaffolding expectations):
npm run check:create-rezi-templates