CLI

Five command groups: migrate · recover · studio · db · schema. The same binary that ships the engine ships these.

#Migrations

Generate, plan, verify, apply, roll back. Every operation is risk-classified and audited per step.

SHELLterminal

13 lines


1zanith migrate generate <name>           # scaffold a migration
2     [--from-diff]                       # auto-fill from live-DB drift
3zanith migrate plan [--json]             # risk summary, no writes
4     [--max-risk <n>]                    # CI gate (0–100)
5zanith migrate verify                    # apply on shadow + diff
6zanith migrate up [--to <id>]            # apply pending
7     [--shadow-verified]                 # honor-system gate
8     [--allow-destructive]               # opt in to drops
9     [--max-risk <n>] [--dry-run]
10zanith migrate down [--steps <n>]        # roll back
11zanith migrate status                    # applied / pending list
12zanith migrate diff [--out <file>]       # bootstrap SQL
13zanith migrate history [--verbose]       # per-step risk + snapshots

#Recovery (Phase 2)

Every destructive op writes a row to _zanith_migration_artifacts. These commands walk that table.

SHELLterminal

10 lines


1zanith recover list                      # all reversible artifacts
2zanith recover inspect <table[.col]>     # row + recovery_sql
3zanith recover restore-column <t.col>    # re-add column
4     [--pk <pkColumn>]                   # archive-restore join key
5zanith recover restore-table <table>     # re-add table
6zanith recover export <table[.col]>      # archive rows out
7     [--format csv|json|jsonl]
8     [--out <file>] [--limit <n>]
9zanith recover purge <artifact-id>       # drop archive + delete row
10zanith cleanup --older-than <Nd>         # bulk purge by age

#Studio

The bundled web UI — runs in-process with the engine. Three deployment modes via auth flags.

SHELLterminal

10 lines


1zanith studio                            # http://127.0.0.1:4321
2     [--port <n>] [--host <h>]
3     [--allow-sql]                       # raw-SQL playground on
4     [--auth-token <t>]                  # admin (full access)
5     [--read-only-auth-token <t>]        # viewer (safe GETs only)
6     [--workspace-data-dir <path>]       # default ~/.zanith
7     [--project-root <path>]             # zanith.config search root
8     [--no-project]                      # skip declared schema
9     [--activity-log]                    # NDJSON activity to disk
10     [--audit-log [<path>]]              # mutating-request audit

#Schema + DB

Read-side commands for inspecting the live database and checking for drift.

SHELLterminal

4 lines


1zanith db introspect                     # print live-DB summary
2zanith schema check                      # diff declared vs live
3                                         # exit 1 on drift
4zanith schema diff [--out <file>]        # SQL to bring DB into sync

#Configuration

The CLI reads zanith.config.{ts,mjs,js,cjs} in the current directory. The default export is the same object you pass to createZanith — adapter, schema, plus optional migrationsDir, safety, and shadow blocks.

Field	What it controls
`adapter`	Database connection (PgAdapter / SqliteAdapter / postgres.js)
`schema`	The compiled schema graph
`migrationsDir`	Where migration files live (default: `migrations`)
`safety.requireShadowDbInProduction`	Refuse `up` without `--shadow-verified` in prod
`shadow.adapter`	Throwaway Postgres for `migrate verify`
`shadow.resetShadow`	Hook to wipe shadow before each verify