The Studio CLI

@svgrid/studio is the command-line generator. One command reads a schema or a live database and writes a working CRUD screen into your SvelteKit app.

New here? Start with Getting started for the full step-by-step path (create an app, install, first screen). This page is the CLI reference.

npx @svgrid/studio add <name> [--from <schema> | --db <dialect> --url <conn>] [options]

`designer`

Open the visual app designer in your browser, auto-saving to studio.config.json and generating the app to a folder. See Launch the designer for the full guide.

npx @svgrid/studio designer [--config <path>] [--out <dir>] [--port <n>] [--no-open]

`add`

Generates three files for an entity: the schema module, the API route, and the page.

Flag	Description
`--from <path>`	Introspect a schema file: a Drizzle `schema.ts` or a Prisma `schema.prisma` (auto-detected).
`--db <dialect>`	Connect to a live database: `postgres` \| `supabase` \| `mysql` \| `mssql` \| `sqlite`.
`--url <conn>`	Connection string (or file path for SQLite) for `--db`.
`--all`	Scaffold a screen for every table/model - works with `--from` or `--db`.
`--table <name>`	Which table/model to use (defaults to `<name>`).
`--sql`	Emit a `createSqlDataSource` with an `execute()` stub instead of a live driver.
`--route <seg>`	Route segment (default: `<name>` / table name).
`--api <path>`	API route path (default: `/api/<route>`).
`-h`, `--help`	Show help.

Examples

# from a live database
npx @svgrid/studio add customers --db postgres --url "$DATABASE_URL"

# every table in the database
npx @svgrid/studio add --all --db mysql --url "$DATABASE_URL"

# from a Drizzle schema file, a specific table, custom route
npx @svgrid/studio add orders --from src/lib/db/schema.ts --table orders --route sales/orders

# every model in a Prisma schema (relations become lookups)
npx @svgrid/studio add --all --from prisma/schema.prisma

# SQLite file
npx @svgrid/studio add todos --db sqlite --url ./data.db

What it writes

For add customers:

src/lib/customers.schema.ts          # EntitySchema + row type
src/routes/api/customers/+server.ts  # API route (createKitHandlers + a data source)
src/routes/customers/+page.svelte    # the screen: grid + edit panel

Then npm run dev and open /customers.

A whole app with `--all`

--all scaffolds every table/model, plus an app shell that ties them together. It works from a live database (--db) or a schema file (--from a Drizzle schema.ts or Prisma schema.prisma):

src/routes/+layout.svelte   # nav sidebar linking every entity screen
src/routes/+page.svelte      # home page: a card per entity
src/routes/<entity>/...      # one screen per table/model (as above)

Foreign keys are resolved across the whole set - a Drizzle .references() or a Prisma @relation becomes a searchable lookup - so each relation points at the right related screen and every /api/<entity> route it needs exists. The same output is available programmatically as scaffoldApp(schemas, options) from @svgrid/enterprise/studio, fed by introspectDrizzleAll / introspectPrismaAll.

Safe regeneration

Every generated file wraps its body in svgrid:managed markers. Re-running add replaces only the managed region and preserves everything you wrote outside it - so you can regenerate after a schema change without losing customizations. See Code generation.

Verification

After writing files, run your project's own check to confirm they compile:

npx svelte-check

Requirements

@svgrid/grid and @svgrid/enterprise in your project, plus the driver for your database (pg / mysql2 / mssql / better-sqlite3) when using --db. Studio is part of the Enterprise license (soft-gate).