Skip to content

jsorm configure

jsorm configure is an interactive assistant that creates jsorm.config.ts and directory structure.

Terminal window
pnpm dlx @jsorm/cli configure
  1. Detect project (framework, runtime, package manager)
  2. Ask for models path (default: src/models)
  3. Ask for access (Server / Client)
  4. Select provider (filtered by access)
  5. If SQLite → ask mode (File / In-memory)
  6. Select field naming (camelCase / snake_case)
  7. Ask if it should generate example model (User)
  8. Generate files
  • Add database — adds a new database
  • Edit configuration — edits jsorm.config.ts manually
  • Full reconfigure — runs the full wizard again
File Content
jsorm.config.ts Config with provider, naming, databases
.env Auto-generated CURSOR_SECRET (if applicable)
.env.example Documented environment variables
src/models/server/main/ Server models directory
src/models/client/main/ Client models directory
src/models/server/main/User.ts Example model (optional)
.jsorm/ Directory for generated types
.gitignore .jsorm added automatically
naming.fields JS property DB column
camelCase (default) emailVerified emailVerified
snake_case emailVerified email_verified

Table names are explicit.

Provider Access Status Options
SQLite server ✅ database
PostgreSQL server ✅ url
IndexedDB client ✅ dbName

At the end it asks if you want to install dependencies now:

Terminal window
pnpm add @jsorm/core @jsorm/client @jsorm/provider-sqlite-node
pnpm add -D @jsorm/cli