Getting Started
Create Rezi
create-rezi scaffolds Rezi apps from a small public starter set.
create-rezi scaffolds Rezi apps from a small public starter set.
Public templates
| Template | Purpose |
|---|---|
minimal | Small utility starter with the smallest surface area. |
cli-tool | Routed multi-screen workflow starter for product-style terminal apps. |
starship | Advanced console starter with tabs, charts, overlays, and broad widget coverage. |
Use --template minimal, --template cli-tool, or --template starship to select one directly.
npm create rezi my-app
cd my-app
npm run startIf you prefer Bun:
bun create rezi my-app
cd my-app
bun run startTemplate conventions
The public templates share the same baseline structure:
src/types.tssrc/theme.tssrc/helpers/src/screens/src/main.tssrc/__tests__/
Each template includes example tests for reducer logic, widget rendering, and keybinding mapping. src/theme.ts is the canonical place for template identity plus theme catalog/style helpers.
Dev loop
The public templates ship with hot state-preserving reload in npm run dev / bun run dev:
- the dev script runs
tsx src/main.ts --hsr - source changes hot-swap through
createNodeApp({ hotReload: ... }) - app state, focus, and stable widget local state are preserved across edits
Next steps
- Quickstart for manual setup.
- Examples for repository examples and their public/internal split.
- Animation Guide for transition/spring/sequence/stagger usage patterns.