Skip to main content

ZenStack CLI Reference

Usage​

zenstack [options] [command]
ΞΆ ZenStack is a Prisma power pack for building full-stack apps.
Documentation: https://zenstack.dev.
Options:
  -v --version           display CLI version
  -h, --help             display help for command
Commands:
  init [options] [path]  Initialize an existing project for ZenStack.
  generate [options]     Generates RESTful API and Typescript client for your data model.
  help [command]         display help for command
zenstack [options] [command]
ΞΆ ZenStack is a Prisma power pack for building full-stack apps.
Documentation: https://zenstack.dev.
Options:
  -v --version           display CLI version
  -h, --help             display help for command
Commands:
  init [options] [path]  Initialize an existing project for ZenStack.
  generate [options]     Generates RESTful API and Typescript client for your data model.
  help [command]         display help for command

Sub Commands​

init​

Initializes an existing project to use ZenStack.

bash
zenstack init [options] [path]
bash
zenstack init [options] [path]

Arguments​

NameDescriptionDefault
pathProject pathcurrent folder

Options​

NameDescriptionDefault
--prismalocation of Prisma schema file to bootstrap from<project path>/prisma/schema.prisma
-p, --package-managerpackage manager to use: "npm", "yarn", or "pnpm"auto detect

Examples​

Initialize current folder with default settings.

bash
npx zenstack init
bash
npx zenstack init

Initialize "myapp" folder with custom package manager and schema location.

bash
npx zenstack init -p pnpm --prisma prisma/my.schema myapp
bash
npx zenstack init -p pnpm --prisma prisma/my.schema myapp

generate​

Generates Prisma schema and other artifacts as specified by "plugin"s in ZModel.

bash
zenstack generate [options]
bash
zenstack generate [options]

Options​

NameDescriptionDefault
--schemaschema file (with extension .zmodel)./schema.zmodel
-p, --package-managerpackage manager to use: "npm", "yarn", or "pnpm"auto detect

Examples​

Generate with default settings.

bash
npx zenstack generate
bash
npx zenstack generate

Generate with custom package manager and schema location.

bash
npx zenstack generate -p pnpm --schema src/my.zmodel
bash
npx zenstack generate -p pnpm --schema src/my.zmodel