Runtime Commands

Start, serve, and manage your application's runtime processes — API server, queue workers, scheduler, UI, and developer tools.

npm

npm run maker <command> [options]

pnpm

pnpm maker <command> [options]

yarn

yarn maker <command> [options]

bun

bun maker <command> [options]

Development Server

dev

Start the full development stack — API server, UI, queue worker (if Redis enabled), and optional dev tools — all in parallel with a single command.

What starts:

Process	Started when	Command
API server	Always	serve --src (hot-reload via tsx watch)
UI	UI != "false"	Vite dev server on port 5173
Queue worker	REDIS != "false"	queue:work --queue=default,mail --src
Optional tools	--view / --with flags	MailDev, Redis Commander, Drizzle Studio

All child processes are tracked. If any required process exits unexpectedly, the entire stack shuts down.

npm

npm run maker dev

pnpm

pnpm maker dev

yarn

yarn maker dev

bun

bun maker dev

Additional tools

npm

npm run maker dev -- --view=redis,maildev,studio
npm run maker dev -- --with-redis-view --with-maildev --with-db-studio

pnpm

pnpm maker dev --view=redis,maildev,studio
pnpm maker dev --with-redis-view --with-maildev --with-db-studio

yarn

yarn maker dev --view=redis,maildev,studio
yarn maker dev --with-redis-view --with-maildev --with-db-studio

bun

bun maker dev --view=redis,maildev,studio
bun maker dev --with-redis-view --with-maildev --with-db-studio

Tool	Flag	What it provides
Redis Commander	redis / --with-redis-view	Web UI at port 1369 to inspect Redis keys
MailDev	maildev / --with-maildev	SMTP server at port 1089 + web UI at port 1080 to view sent emails
Drizzle Studio	studio / --with-db-studio	Web UI at local.drizzle.studio for database browsing

ui:dev

Start only the UI dev server (alias: admin:dev). Useful when you want to run the API separately.

npm

npm run maker ui:dev

pnpm

pnpm maker ui:dev

yarn

yarn maker ui:dev

bun

bun maker ui:dev

Production Server

serve

Start the HTTP API server.

Flags:

Flag	Default	Description
--prod	—	Run compiled dist/src/framework/server.js
--runtime <name>	node	Runtime: node or bun
--watch	—	Watch for file changes (source mode)
--src	—	Force source mode even if dist/ exists

npm

npm run maker serve
npm run maker serve -- --prod
npm run maker serve -- --prod --runtime=node
npm run maker serve -- --runtime=bun
npm run maker serve -- --watch
npm run maker serve -- --src

pnpm

pnpm maker serve
pnpm maker serve --prod
pnpm maker serve --prod --runtime=node
pnpm maker serve --runtime=bun
pnpm maker serve --watch
pnpm maker serve --src

yarn

yarn maker serve
yarn maker serve --prod
yarn maker serve --prod --runtime=node
yarn maker serve --runtime=bun
yarn maker serve --watch
yarn maker serve --src

bun

bun maker serve
bun maker serve --prod
bun maker serve --prod --runtime=node
bun maker serve --runtime=bun
bun maker serve --watch
bun maker serve --src

Queue

queue:work

Start a BullMQ queue worker that processes jobs from named queues.

Flag	Default	Description
--queue <names>	default	Comma-separated queue names (e.g. default,mail,maintenance)
--prod	—	Run from compiled dist/ instead of source
--runtime <name>	node	Runtime: node or bun
--src	—	Force source mode even if dist/ exists

npm

npm run maker queue:work
npm run maker queue:work -- --queue=mail
npm run maker queue:work -- --queue=default,mail,maintenance
npm run maker queue:work -- --prod
npm run maker queue:work -- --queue=default,mail --prod --runtime=node

pnpm

pnpm maker queue:work
pnpm maker queue:work --queue=mail
pnpm maker queue:work --queue=default,mail,maintenance
pnpm maker queue:work --prod
pnpm maker queue:work --queue=default,mail --prod --runtime=node

yarn

yarn maker queue:work
yarn maker queue:work --queue=mail
yarn maker queue:work --queue=default,mail,maintenance
yarn maker queue:work --prod
yarn maker queue:work --queue=default,mail --prod --runtime=node

bun

bun maker queue:work
bun maker queue:work --queue=mail
bun maker queue:work --queue=default,mail,maintenance
bun maker queue:work --prod
bun maker queue:work --queue=default,mail --prod --runtime=node

queue:clear

Delete all queue-related Redis keys. Useful for resetting stale job state during development.

npm

npm run maker queue:clear

pnpm

pnpm maker queue:clear

yarn

yarn maker queue:clear

bun

bun maker queue:clear

Scheduler

schedule:work

Start the cron scheduler worker. Executes scheduled tasks defined with defineSchedule() on their configured intervals.

npm

npm run maker schedule:work
npm run maker schedule:work -- --prod

pnpm

pnpm maker schedule:work
pnpm maker schedule:work --prod

yarn

yarn maker schedule:work
yarn maker schedule:work --prod

bun

bun maker schedule:work
bun maker schedule:work --prod

Testing

test

Run Vitest backend tests once.

npm

npm run maker test
npm run maker test -- -- --filter=posts

pnpm

pnpm maker test
pnpm maker test --filter=posts

yarn

yarn maker test
yarn maker test --filter=posts

bun

bun maker test
bun maker test --filter=posts

test:watch

Run Vitest backend tests in watch mode — re-runs on file changes.

npm

npm run maker test:watch

pnpm

pnpm maker test:watch

yarn

yarn maker test:watch

bun

bun maker test:watch

test:coverage

Run Vitest backend tests with code coverage reporting.

npm

npm run maker test:coverage

pnpm

pnpm maker test:coverage

yarn

yarn maker test:coverage

bun

bun maker test:coverage

test:ui

Run Vitest backend tests in the visual UI mode.

npm

npm run maker test:ui

pnpm

pnpm maker test:ui

yarn

yarn maker test:ui

bun

bun maker test:ui

Dev Tools

maildev:view

Start MailDev — a combined SMTP server and web email viewer. Catches all outgoing emails during development.

Service	Port
SMTP	1089
Web UI	1080

npm

npm run maker maildev:view

pnpm

pnpm maker maildev:view

yarn

yarn maker maildev:view

bun

bun maker maildev:view

redis:view

Start Redis Commander — a web UI to browse and manage Redis keys.

Service	Port
Web UI	1369

npm

npm run maker redis:view

pnpm

pnpm maker redis:view

yarn

yarn maker redis:view

bun

bun maker redis:view

vite:cache:clear

Clear Vite caches. Removes .vite directories from node_modules, src/resources, and other locations.

npm

npm run maker vite:cache:clear

pnpm

pnpm maker vite:cache:clear

yarn

yarn maker vite:cache:clear

bun

bun maker vite:cache:clear

Summary

Command	Development	Production
dev	Full stack (API + UI + queue + tools)	—
serve	API with watch	API without watch
queue:work	Queue worker from source	Queue worker from dist
schedule:work	Scheduler from source	Scheduler from dist
ui:dev	Vite dev server	—
test	Run tests once	—
test:watch	Run tests in watch mode	—
test:coverage	Run tests with coverage	—
test:ui	Run tests in UI mode	—
queue:clear	Development cleanup	—
maildev:view	Email testing	—
redis:view	Redis inspection	—
vite:cache:clear	Cache cleanup	—