@flowpanel/cli

The flowpanel CLI — scaffold, develop, ship.

Bootstrap with pnpm dlx @flowpanel/cli init — it installs @flowpanel/kit plus this CLI as a devDependency, so every later command runs as pnpm flowpanel <command>.

Commands

flowpanel init                 Detect stack and scaffold config + wiring
                               --yes --dry-run --json
flowpanel dev                  Start `next dev` (and bull-board if REDIS_URL set)
flowpanel new <resource>       Add a resource(...) entry to flowpanel.config.ts
                               --table <expr>   Override the schema table reference
                               --kind prisma    Generate string-literal first arg
                               --dry-run --json
flowpanel migrate              Apply SQL migrations from flowpanel/migrations/
                               --dry-run --json
flowpanel doctor [--fix]       Health check; --fix writes missing route files
                               --dry-run --json
flowpanel eject <target>       Take ownership of a piece of FlowPanel
                               resource <name>
                               dashboard <path>
                               layout
                               --force          Overwrite existing files
                               --dry-run --json

What init writes

flowpanel.config.ts
app/admin/[[...slug]]/page.tsx
app/api/flowpanel/[...route]/route.ts
app/api/flowpanel/stream/route.ts
styles/admin.css
flowpanel/migrations/0001_init.sql

Plus, conditionally: tailwind.config.ts (Tailwind v3 projects only) and app/layout.tsx (created when missing, otherwise safely patched).

Mutating commands compute a complete plan first. Existing files with different content are conflicts unless eject --force explicitly targets one; writes are atomic and rolled back if a later file fails.

What eject does

Each ejected file is stamped with // flowpanel: ejected @ <semver> — this file is yours. The matching config entry is commented out in flowpanel.config.ts via ts-morph (resource + dashboard targets); layout is auto-applied by Next.js's segment system.

Documentation

https://flowpanel.tech

License

MIT