ORM Studio

Axil ORM Studio is a browser-based developer dashboard that launches automatically alongside your development server when you run axil run. No extra commands, no configuration — it just opens.

What is ORM Studio?#

ORM Studio gives you a complete view of your running AxilJS application:

• API Explorer — Browse every HTTP route with method badges, path params, middleware tags, handler names, and a built-in Try It Out panel
• Database Browser — Inspect tables, columns, types, constraints, defaults, and browse paginated row data
• SQL Query Editor — Run SELECT queries directly against your database and see results in a data grid
• Realtime Monitor — Connect to WebSocket endpoints, send messages, and watch live SSE streams
• Export Collections — Download Postman, Insomnia, and OpenAPI 3.0 collections from your discovered routes
• QR Code Access — Scan a QR code to open your app or Studio on any device on the same network

How It Works#

When you run axil run, the CLI:

1. Compiles your TypeScript
2. Starts your application on the configured port
3. Starts Studio on appPort + 1 automatically
4. Opens your browser to the Studio dashboard
5. Connects to your database independently (read-only)

axil run
 
 AxilJS development server
 ─────────────────────────────────────
 
12:00:01 [axil run] Compiled project in 850ms
12:00:01 [axil run] Starting dist/main.js
12:00:01 [AxilJS]   Server listening on http://localhost:3000
12:00:02 [AxilJS Studio] http://localhost:3001

Studio Dashboard#

Studio has six panels accessible from the sidebar:

Database Support#

Studio auto-detects your database from .env and connects independently:

The connection is read-only — Studio will never write to or modify your database.

Auto-Refresh#

Studio refreshes data every 30 seconds automatically. You can also click the Refresh button in the top bar at any time to get the latest routes and table data.