The vertz.config.ts file at your project root configures the Vertz compiler, codegen, and cloud settings.
Basic structure
The default export configures the compiler. Named exports configure other subsystems (codegen, database).
Entry file detection
The Vertz runtime auto-detects entry files by convention. You do not need to specify them in config:
| Convention | Purpose |
|---|
src/entry-client.ts | Client-side hydration entry |
src/app.tsx | SSR entry (server-side rendering) |
src/api/server.ts | API server entry |
Do not add an entryFile property to your config — it is not a valid option and will be
silently ignored.
Compiler options
All fields are optional. The defaults shown above apply when omitted.
Codegen options
The typescript generator creates a fully typed SDK at .vertz/generated/client.ts from your entity and service definitions. This runs automatically during vtz dev and vtz build.
Cloud options
Only needed when deploying to Vertz Cloud.
defineConfig helper
For type-checked configuration, use defineConfig:
Scaffold default
Projects created with vtz create start with a minimal config:
This uses all defaults — which is the right starting point for most projects.