create-cascade

Scaffold a new Cascade project (core, react, solid) with starter templates.

Overview

create-cascade is the official project generator. It scaffolds a ready-to-run Cascade app with a chosen framework (core/React/Solid) and a starter preset.

# Interactive mode
bun create cascade

By default it only writes files. Use flags if you want the generator to install dependencies or start the dev server automatically.

Frameworks and starters

Frameworks:

Framework	Use when…	Typical entry
`core`	You prefer imperative renderables/constructs and direct control over nodes.	`createCliRenderer` + `root.add`
`react`	You want React state/effects and declarative composition.	`createRoot(renderer).render`
`solid`	You want Solid signals + declarative composition.	`render(() => <App />)`

Starters depend on the framework. For example, React includes minimal, counter, and login.

# Create a React app with the counter starter
bun create cascade my-app -f react -s counter

CLI options

Options:
  -f, --framework <name>  Framework: core, react, solid
  -s, --starter <name>    Starter preset for selected framework
  --here                  Use current directory
  --install               Run bun install after scaffolding
  --start                 Run bun install, then bun run dev
  -h, --help              Show help

Flag	Behavior	Notes
`--here`	Scaffold into the current directory.	Fails if the folder is not empty (to prevent overwriting).
`--install`	Runs `bun install` after scaffolding.	Good for quick starts; skip if you want to inspect files first.
`--start`	Runs `bun install` then `bun run dev`.	Implied `--install`.
`-f` / `--framework`	Selects the framework (`core`, `react`, `solid`).	Use in scripts to avoid interactive prompts.
`-s` / `--starter`	Selects the starter preset for the chosen framework.	Pair it with `-f`.

Tips:

- If you’re scripting CI scaffolds, pass -f and -s explicitly to avoid interactive prompts.

- Prefer --install over doing installs yourself when you want consistent generator behavior.

Behavior and workflow

The generator is intentionally conservative: it scaffolds files first and only installs/runs when you opt in. A typical workflow is:

- Scaffold (interactive or scripted)

- Run bun install

- Run bun run dev

If you’re building libraries or CI templates, prefer keeping scaffold and install separate for reproducibility.