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 commandCommands: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 commandCommands: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β
Name | Description | Default |
---|---|---|
path | Project path | current folder |
Optionsβ
Name | Description | Default |
---|---|---|
--prisma | location of Prisma schema file to bootstrap from | <project path>/prisma/schema.prisma |
-p, --package-manager | package 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β
Name | Description | Default |
---|---|---|
--schema | schema file (with extension .zmodel) | ./schema.zmodel |
-p, --package-manager | package 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