Quick start
Scaffold a typed Beast and Octane application with your preferred bundler and UI library.
Use Node.js 22.22.2 or newer and a current stable release of Bun. The project creator configures Beast and Octane for the selected Vite, Rspack, or Rsbuild pipeline.
- Node.js 22.22.2 or newer
- Bun (current stable)
- A modern browser for the generated application
Run the creator and pass a directory to skip the interactive name prompt.
Terminalshell
bun create beast@latest my-appcd my-appbun run dev- Beast and Octane configured for the selected Vite, Rspack, or Rsbuild pipeline
- The selected Octane-native Base UI, Radix, or shadcn package
- A typed App.btsx component
- TSRX-aware checking through tsrx-tsc
- Development, build, preview, type-check, and combined check scripts
- A focused .gitignore and optional initialized Git repository
| Option | Effect |
|---|---|
| --bundler NAME | Select vite, rspack, or rsbuild without the interactive prompt |
| --ui NAME | Select base-ui, radix, or shadcn without the interactive prompt |
| --no-install | Write the project without running bun install |
| --no-git | Skip git init |
| --force | Write known template files into a non-empty directory |
| -h, --help | Print command help |
| --tailwind | Add Tailwind CSS; selecting shadcn enables it automatically |