create-beignet
v0.0.22
Published
Create a new Beignet app with one command.
Maintainers
Readme
create-beignet
[!CAUTION] Beignet is experimental alpha software. The
0.0.xpackage line is for early evaluation, and APIs may change between releases while the framework settles.
Create a new Beignet app with one command.
Create an app
bun create beignet my-appOther package managers work the same way:
npm create beignet@latest my-app
pnpm create beignet my-app
yarn create beignet my-appAfter creation:
cd my-app
bun install
cp .env.example .env.local
bun beignet db migrate
bun run devInteractive setup
Running bare bun create beignet in an interactive terminal opens a
prompt-based setup that asks for the project directory, whether to scaffold
an API-only app, which database to use, and which provider integrations to
add. Passing any selection flag (--api, --db, --integrations, or
--package-manager) skips the prompts, and --yes forces the
non-interactive defaults (the full-stack SQLite starter with bun) even on a
terminal:
bun create beignet my-app --yesFlags
create-beignet is a thin wrapper around beignet create, so every flag
passes through unchanged:
bun create beignet my-app --api --integrations inngest,resend
bun create beignet my-app --db postgres--db picks the database backend: sqlite (the default), postgres, or
mysql. Every backend scaffolds provider wiring, schema, the vendored initial
migration, env examples, and tests for that database.
See the
@beignet/cli README
for the full list of flags and integrations, plus the beignet commands
available inside a generated app.
