zenstack/docs/cli-commands.md

CLI commands

init

Set up ZenStack for an existing Next.js + Typescript project.

npx zenstack init [options] [dir]

Options:

    -p, --package-manager <pm>: package manager to use: "npm", "yarn", or "pnpm" (default: auto detect)

generate

Generates RESTful CRUD API and React hooks from your model.

npx zenstack generate [options]

Options:

    --schema <file>: schema file (with extension .zmodel) (default: "./zenstack/schema.zmodel")

    -p, --package-manager <pm>: package manager to use: "npm", "yarn", or "pnpm" (default: auto detect)

migrate

Update the database schema with migrations.

Sub-commands:

migrate dev

Create a migration from changes in Prisma schema, apply it to the database, trigger generation of database client. This command wraps prisma migrate command.

npx zenstack migrate dev [options]

Options:

    --schema <file> schema file (with extension .zmodel) (default: "./zenstack/schema.zmodel")

migrate reset

Reset your database and apply all migrations.

npx zenstack migrate reset [options]

Options:

    --schema <file> schema file (with extension .zmodel) (default: "./zenstack/schema.zmodel")

migrate deploy

Apply pending migrations to the database in production/staging.

npx zenstack migrate deploy [options]

Options:

    --schema <file> schema file (with extension .zmodel) (default: "./zenstack/schema.zmodel")

migrate status

Check the status of migrations in the production/staging database.

npx zenstack migrate status [options]

Options:

    --schema <file> schema file (with extension .zmodel) (default: "./zenstack/schema.zmodel")

db

Manage your database schema and lifecycle during development. This command wraps prisma db command.

Sub-commands:

db push

Push the state from model to the database during prototyping.

npx zenstack db push [options]

Options:

    --schema <file> schema file (with extension .zmodel) (default: "./zenstack/schema.zmodel")
    --accept-data-loss  Ignore data loss warnings

studio

Browse your data with Prisma Studio. This command wraps prisma studio command.

npx zenstack studio [options]

Options:

    --schema <file>         schema file (with extension .zmodel) (default: "./zenstack/schema.zmodel")
    -p --port <port>        Port to start Studio in
    -b --browser <browser>  Browser to open Studio in
    -n --hostname           Hostname to bind the Express server to