Getting Started
BoilerBear is a UI-driven scaffolder. You pick a stack in the browser, copy a single shell command, and end up with a working project on disk in under a minute. No accounts. No backend. The plan lives in the URL.
1. Open the builder
Head to /builder. You'll see a five-step wizard:
- Basics — project name + package manager (
pnpm,npm,yarn,bun). - Framework — pick a base framework (Vite, Next.js, …). Other modules are filtered by what this framework supports.
- Modules — toggle libraries from tabbed categories (Styling, Components, State, Data, …). Conflicts and missing requirements are flagged inline.
- Review — resolved install order, unique package count, warnings.
- Generate — copy the one-line command, or copy the share URL.
2. Copy the command
On the Generate step you get a bash -c '…' one-liner:
bash -c 'set -euo pipefail
pnpm create vite@latest my-app -- --template react-ts
cd "my-app"
pnpm add -D tailwindcss@^3.4.0 postcss@^8.4.0 autoprefixer@^10.4.0
mkdir -p .
cat > postcss.config.cjs <<"BB_EOF"
module.exports = { plugins: { tailwindcss: {}, autoprefixer: {} } };
BB_EOF'
Paste it in an empty directory. The script:
- Creates the project with the framework's official
createcommand. cds into the directory.- Installs all dependencies (deduped across modules).
- Writes any config files the modules need.
3. Share the URL
Click the Share tab. The plan is encoded as ?s=<hash> in the URL — the entire spec, no DB. Send the link; whoever opens it sees the same builder state and can rebuild or modify.
The same plan can be installed via the CLI shim:
npx @boilerbear/cli@latest run <hash>
See CLI reference for the full command surface.
What's next
- Add more modules — the registry lives at packages/modules/src/.
- Author a recipe (pre-bundled stack) — see ADDING_A_MODULE.md.
- File a bug or request a module — open an issue.