jsorm configure
jsorm configure is an interactive assistant that creates jsorm.config.ts and directory structure.
pnpm dlx @jsorm/cli configureFlow (first run)
Section titled “Flow (first run)”- Detect project (framework, runtime, package manager)
- Ask for models path (default:
src/models) - Ask for access (Server / Client)
- Select provider (filtered by access)
- If SQLite → ask mode (File / In-memory)
- Select field naming (camelCase / snake_case)
- Ask if it should generate example model (User)
- Generate files
Flow (existing config)
Section titled “Flow (existing config)”- Add database — adds a new database
- Edit configuration — edits
jsorm.config.tsmanually - Full reconfigure — runs the full wizard again
Generated files
Section titled “Generated files”| 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
Section titled “Naming”naming.fields |
JS property | DB column |
|---|---|---|
camelCase (default) |
emailVerified |
emailVerified |
snake_case |
emailVerified |
email_verified |
Table names are explicit.
Supported providers
Section titled “Supported providers”| Provider | Access | Status | Options |
|---|---|---|---|
| SQLite | server | ✅ | database |
| PostgreSQL | server | ✅ | url |
| IndexedDB | client | ✅ | dbName |
Dependency installation
Section titled “Dependency installation”At the end it asks if you want to install dependencies now:
pnpm add @jsorm/core @jsorm/client @jsorm/provider-sqlite-nodepnpm add -D @jsorm/cli