Skip to main content

CLI Reference

Commands​

brizzle init​

Interactive setup wizard for Drizzle ORM configuration.

brizzle init

Options:

  • --dialect <dialect> - Database dialect (sqlite, postgresql, mysql) for non-interactive mode
  • --driver <driver> - Database driver for non-interactive mode
  • --no-install - Skip automatic dependency installation

Example:

# Interactive mode
brizzle init

# Non-interactive mode
brizzle init --dialect postgresql --driver postgres

brizzle model​

Creates a Drizzle schema model.

brizzle model <name> [fields...]

Arguments:

  • name - Model name (singular, e.g., user, post)
  • fields - Field definitions (see Field Types)

Example:

brizzle model user name:string email:string:unique

brizzle actions​

Creates server actions for an existing model.

brizzle actions <name>

Arguments:

  • name - Model name (must exist in schema)

Example:

brizzle actions user

brizzle resource​

Creates model + actions (no UI pages).

brizzle resource <name> [fields...]

Arguments:

  • name - Model name
  • fields - Field definitions

Example:

brizzle resource session token:uuid userId:references:user

brizzle scaffold​

Creates model + actions + CRUD pages.

brizzle scaffold <name> [fields...]

Arguments:

  • name - Model name
  • fields - Field definitions

Example:

brizzle scaffold product name:string price:float description:text?

brizzle api​

Creates model + REST API routes.

brizzle api <name> [fields...]

Arguments:

  • name - Model name
  • fields - Field definitions

Example:

brizzle api webhook url:string secret:string:unique

brizzle destroy​

Removes generated files (does not modify schema).

brizzle destroy <type> <name>

Arguments:

  • type - Generator type (scaffold, api, actions, resource)
  • name - Model name

Example:

brizzle destroy scaffold post
brizzle destroy api product --dry-run

brizzle config​

Shows detected project configuration.

brizzle config

Output:

Project Configuration:
  Structure: app/
  Path alias: @
  DB path: db
  Dialect: sqlite

Global Options​

These options work with all generator commands:

OptionShortDescription
--force-fOverwrite existing files
--dry-run-nPreview changes without writing
--uuid-uUse UUID for primary key
--no-timestampsSkip createdAt/updatedAt fields
--help-hShow help for command

Examples​

Dry Run​

Preview what would be generated:

brizzle scaffold post title:string --dry-run

Force Overwrite​

Regenerate files even if they exist:

brizzle scaffold post title:string body:text --force

UUID Primary Keys​

Use UUIDs instead of auto-incrementing integers:

brizzle scaffold post title:string --uuid

Skip Timestamps​

Create model without createdAt/updatedAt:

brizzle model setting key:string value:text --no-timestamps