zenstack-project-setup — Claude Code skill: ZenStack setup
The zenstack-project-setup Claude Code skill sets up ZenStack V3 projects, scaffolds new ones, and runs zen CLI tasks. It activates for ZenStack installation, project creation, or CLI use.
MIT 510 installs ★ 3 updated 2026-10-28
npx skills add zenstackhq/skills --skill zenstack-project-setup -a claude-codeWhat zenstack-project-setup does
The skill guides ZenStack V3 installation, project setup, and CLI use. It works with zenstack/schema.zmodel, generates TypeScript with zen generate, and covers database migration commands. Prisma conversions and upgrades from ZenStack V2 use separate skills.
Node.js v20+ and TypeScript v5.8.0+ are required. ZenStack does not bundle database drivers: PostgreSQL uses pg, MySQL uses mysql2, and SQLite uses better-sqlite3. Use zen db push for development or testing, not production; zen migrate deploy applies pending migrations.
What it helps with
- scaffold a ZenStack V3 project
- add ZenStack to an existing codebase
- generate a TypeScript client from ZModel
- choose a CLI command for database migrations
Example prompts for the agent
- Create a new ZenStack project named
my-project. - Set up ZenStack in this project and generate code from
zenstack/schema.zmodel. - Explain how to apply ZenStack migrations in production.
How to install zenstack-project-setup
1Skills CLI (Vercel)
npx skills add zenstackhq/skills --skill zenstack-project-setup -a claude-code2Manually: put the files in place
~/.claude/skills/zenstack-project-setup/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/zenstack-project-setup/
1Skills CLI (Vercel)
npx skills add zenstackhq/skills --skill zenstack-project-setup -a codex2Manually: put the files in place
.agents/skills/zenstack-project-setup/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add zenstackhq/skills --skill zenstack-project-setup -a cursor2Manually: put the files in place
.cursor/skills/zenstack-project-setup/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install zenstackhq/skills skills/zenstack-project-setup2Manually: put the files in place
.github/skills/zenstack-project-setup/SKILL.md1Skills CLI (Vercel)
npx skills add zenstackhq/skills --skill zenstack-project-setup -a gemini-cli2Platform CLI
gemini skills install https://github.com/zenstackhq/skills --path skills/zenstack-project-setupManually: put the files in place
.devin/skills/zenstack-project-setup/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add zenstackhq/skills --skill zenstack-project-setup -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about zenstack-project-setup
How do I install zenstack-project-setup in Claude Code?
Run npx skills add zenstackhq/skills --skill zenstack-project-setup -a claude-code. The skill file is installed at ~/.claude/skills/zenstack-project-setup/SKILL.md.
What does zenstack-project-setup do?
It guides ZenStack V3 installation and project setup, then helps run CLI commands for code generation and database migrations.
What does zenstack-project-setup need to work?
It requires Node.js v20+ and TypeScript v5.8.0+. Install a database driver too: pg for PostgreSQL, mysql2 for MySQL, or better-sqlite3 for SQLite.
Source text
SKILL.md · MIT
---
name: zenstack-project-setup
description: Set up, configure, and manage a ZenStack V3 project. Use when installing ZenStack, scaffolding a new project, or running the `zen` CLI (generate). (For database schema migrations use zenstack-db-migration; to migrate a Prisma project use zenstack-migrate-from-prisma; to upgrade from ZenStack V2 use zenstack-migrate-from-v2.)
---
# ZenStack V3 — Project Setup & Migrations
ZenStack V3 is a TypeScript database toolkit with a Prisma-compatible ORM API built on
[Kysely](https://kysely.dev) (no Rust/WASM). The schema is written in **ZModel** (`.zmodel`), a
superset of the Prisma schema language. This skill covers installing, scaffolding, the CLI, and
migrations. For schema syntax see `zenstack-schema-modeling`; for queries see `zenstack-querying`;
for access control see `zenstack-access-control`.
> Always confirm exact package versions and commands against the live docs at
> https://zenstack.dev/docs when something looks off — V3 evolves quickly.
## Prerequisites
- **Node.js** v20+
- **TypeScript** v5.8.0+
- VSCode extension: "ZenStack V3" (language id `zmodel-v3`) — distinct from the V2 extension.
## Installing
### Scaffold a new project (recommended)
```bash
npm create zenstack my-project
```
### Initialize ZenStack in an existing project
```bash
npx @zenstackhq/cli zen init
```
Then create `zenstack/schema.zmodel` and run `zen generate`.
### Manual install
```bash
npm install @zenstackhq/schema @zenstackhq/orm
npm install --save-dev @zenstackhq/cli
```
ZenStack does **not** bundle database drivers — install one yourself:
| Database | Install |
| ---------- | ------- |
| PostgreSQL | `npm install pg` + `npm install -D @types/pg` |
| MySQL | `npm install mysql2` |
| SQLite | `npm install better-sqlite3` + `npm install -D @types/better-sqlite3` |
Add access control only if needed: `npm install @zenstackhq/plugin-policy` (see
`zenstack-access-control`).
## Project structure
- **Schema**: `zenstack/schema.zmodel` (default; override with `--schema`).
- **Generated output**: emitted next to the schema (override with `--output`). Import it as
`import { schema } from './zenstack/schema'`.
- You may commit the generated TypeScript, or `.gitignore` it and run `zen generate` in CI.
## The `zen` CLI
The CLI is invoked as `zen` (or `zenstack` — equivalent). Add scripts to `package.json`:
```json
{
"scripts": {
"generate": "zen generate",
"db:push": "zen db push",
"migrate:dev": "zen migrate dev",
"migrate:deploy": "zen migrate deploy"
}
}
```
| Command | Purpose |
| ------- | ------- |
| `zen check` | **Only** validate `schema.zmodel` for syntax and semantic errors — does not regenerate anything. Use when you just want to confirm the schema is valid. |
| `zen generate` | Compile `schema.zmodel` → TypeScript (regenerate the database client); also validates the schema as it compiles. **Run after every schema change**, before using the client. Flags: `--schema <path>`, `--output <path>`. |
| `zen db push` | Push schema to the DB **without** a migration file. Dev/testing only — never in production. |
| `zen db pull` | Introspect an existing DB and update the ZModel schema (v3.4.0+, experimental). Can overwrite your schema — back up / use source control first. |
| `zen migrate dev` | Create a migration from schema changes and apply it (dev only). `--create-only` makes an empty migration to edit by hand (e.g. for views). |
| `zen migrate deploy` | Apply all pending migrations. Use this in your production/deploy pipeline. |
| `zen migrate reset` | Drop all tables and reapply migrations. Dev/testing only. |
| `zen migrate status` | Show applied vs. pending migrations. |
| `zen migrate resolve` | Mark a migration applied/rolled-back without changing the schema (manual recovery). |
> Migration commands wrap Prisma Migrate; `@zenstackhq/cli` has a peer dependency on `prisma` that
> is installed automatically when needed.
For the full migration story — `migrate dev`/`deploy`/`reset`/`status`/`resolve`, `db push`/`pull`,
seeding, `--create-only`, and deployment-pipeline guidance — see the `zenstack-db-migration` skill.
## Workflows
**Development loop**
1. Edit `zenstack/schema.zmodel`.
2. `zen generate` (regenerate types).
3. `zen db push` to try changes locally without a migration, *or* `zen migrate dev` to create a
reviewable, committable migration file.
4. Review the migration SQL, then commit it.
**Production deploy**
```bash
zen migrate deploy
```
**Adopt ZenStack on an existing database**
1. `zen init`
2. Set the datasource `url` in `zenstack/schema.zmodel`.
3. `zen db pull` to generate the schema from the DB.
4. Refine it (add access policies, computed fields, etc.).
5. `zen generate`.
## Migrating from Prisma
See the dedicated `zenstack-migrate-from-prisma` skill — it walks through swapping dependencies,
converting `schema.prisma` to ZModel, replacing `PrismaClient` with `ZenStackClient`, updating the
generate/migrate scripts, and mapping Prisma custom generators and client extensions.
## Migrating from ZenStack V2
See the dedicated `zenstack-migrate-from-v2` skill — it covers the package renames, moving access
control to the policy plugin, the `future()` → `post-update`/`before()` change, abstract models →
types+mixins, the `getPrisma` → `getClient` server-adapter change, and the client-side hook
migration.
## Reference docs
Full ZenStack documentation for this topic is bundled under [`references/`](references/):
- [prerequisite.md](references/prerequisite.md) — supported Node/TypeScript versions, IDE setup
- [quick-start.md](references/quick-start.md) — scaffolding and the install paths
- [cli.md](references/cli.md) — overview of every `zen` CLI command
- [cli-reference.md](references/cli-reference.md) — full CLI reference
- [migration.md](references/migration.md) — dev/production migration workflow
- [introspection.md](references/introspection.md) — `zen db pull` from an existing database
© zenstackhq · MIT · zenstackhq/skills