CLI Reference

The maker CLI is the framework's command center — code generation, database management, runtime control, and deployment orchestration, all from one entry point.

How It Works

The CLI is a Node.js script at src/framework/maker-cli/index.mjs registered as the maker binary in package.json. It uses Commander.js for argument parsing and dotenv for environment loading.

npm

npm run maker <command> [options]

pnpm

pnpm maker <command> [options]

yarn

yarn maker <command> [options]

bun

bun maker <command> [options]

Env loading behavior

• All commands except deploy — loads .env before running (so commands have access to DATABASE_URL, REDIS, etc.)
• Deploy commands — skip .env loading because they need to generate .env files first

Package manager detection

The CLI auto-detects your package manager from the npm_config_user_agent env variable:

Detected	Usage hint
npm	npm run maker
pnpm	pnpm maker
yarn	yarn maker
bun	bun maker

Command Categories

Category	File	Commands	Purpose
Module	module/	21	Scaffold modules, facades, providers, controllers, schemas, services, helpers, middlewares, types, models, routes, jobs, seeders, schedules, tests
Middleware	middleware/	1	Generate middleware files in src/middlewares
Provider	provider/	1	Generate provider files in src/providers
Database	database/	14	Schema generation, migrations, seeding, push, studio
Runtime	runtime/	14	Dev server, queue worker, scheduler, UI, testing, dev tools
Deploy	deploy/	6	Docker scaffolding, local/remote compose, workflows, DB import

Architecture

index.mjs (entry)
  ├─ dotenv (load .env, skipped for deploy commands)
  ├─ Commander program
  ├─ registerMiddlewareCommands() → middleware/index.mjs → middleware/core.mjs
  ├─ registerModuleCommands()  → module/index.mjs → module/core.mjs
  ├─ registerProviderCommands() → provider/index.mjs → provider/core.mjs
  ├─ registerDeployCommands()  → deploy/index.mjs → deploy/core.mjs
  ├─ registerDbCommands()      → db/index.mjs     → db/core.mjs
  └─ registerRuntimeCommands() → runtime/index.mjs → runtime/core.mjs

Shared utilities (utils/):
  ├─ help.mjs     — Package manager prefix detection, help display
  ├─ naming.mjs   — Name validation, PascalCase conversion
  ├─ env-db.mjs   — Dialect detection, URL parsing, feature flags
  ├─ flags.mjs    — Flag/option parsing helpers
  ├─ file-ops.mjs — File write strategies (skip, overwrite, batch)
  └─ process.mjs  — Child process spawn, local binary resolution