CLI Reference
The nx CLI is NexusTS' command runner, inspired by AdonisJS Ace and Laravel Artisan.
Global Usage
bun nx <command> [args...]
# Show help
bun nx help
bun nx <command> --help
# Show version
bun nx --versionAll examples below use
nx <command>for brevity. Runbun nx <command>,bun run nx <command>, orbunx nx <command>in your project. Scaffolded projects include"nx": "nx"inpackage.jsonscripts, sobun nx <command>is the shortest form.
Project Commands
nx init / nx i
Initialize NexusTS in an existing directory (non-destructive).
nx init [dir] [options]
nx init --style nest --view inertia --orm drizzle --db sqlite --frontend react| Flag | Description |
|---|---|
--style | Routing style: nest / adonis / functional |
--view | View engine: rendu / edge / eta / inertia / none |
--orm | ORM driver: drizzle / kysely / none |
--db | Database: 'sqlite' / postgres / mysql / none |
--frontend | Inertia frontend: react / vue / svelte / solid |
--no-ssr | Disable Inertia SSR |
--force | Overwrite existing files |
--no-interaction | Skip interactive prompts |
nx new / nx n
Create a new NexusTS project in a fresh directory.
nx new <name> [options]
nx new my-app --style nest --view inertia --orm drizzle --db sqlite --frontend reactSame flags as nx init.
Generator Commands
nx make:controller
Generate a controller class.
nx make:controller User
# Creates app/controllers/user.controller.tsnx make:service
Generate a service class.
nx make:service User
# Creates app/services/user.service.tsnx make:crud
Generate a full CRUD scaffold (controller + service + model + repository).
nx make:crud Post
nx make:crud Post --no-viewsnx make:model
Generate a Drizzle model with schema.
nx make:model User
# Supports --columns, --timestamps, --soft-deletenx make:repository
Generate a repository class.
nx make:repository Usernx make:module
Generate a feature module.
nx make:module Billingnx make:migration
Generate a database migration.
nx make:migration create_users_table
nx make:migration create_users_table --columns "name:text,email:text"nx make:auth
Scaffold authentication (better-auth integration).
nx make:authnx make:schedule
Generate a scheduled task.
nx make:schedule DailyReportnx make:listener
Generate an event listener.
nx make:listener UserRegisterednx make:middleware
Generate a middleware.
nx make:middleware Loggernx make:session
Generate session configuration.
nx make:sessionnx make:validator
Generate a validation schema.
nx make:validator CreateUsernx make:queue
Generate a queue job.
nx make:queue SendEmailDatabase Commands
nx db:generate
Generate Drizzle migrations from schema files.
nx db:generatenx db:migrate
Run pending migrations.
nx db:migratenx db:seed
Run seed files.
nx db:seed
nx db:seed --create users # Create a seed fileDebug Commands
nx route:list
List all registered routes.
nx route:listnx repl
Interactive debug console.
nx repl
# .services — list registered services
# .modules — list registered modules
# .routes — list registered routes
# .help — show available commandsnx info
System diagnostics.
nx info
# Shows: node version, bun version, platform, framework versionConfiguration
NexusTS is configured via nx.config.ts at the project root:
import { defineConfig } from '@nexusts/core';
export default defineConfig({
routing: 'nest', // nest | adonis | functional
view: 'rendu', // rendu | edge | eta | inertia | none
viewPaths: 'resources/views', // template directory
orm: 'drizzle', // drizzle | kysely | none
dbDriver: 'sqlite', // sqlite | postgres | mysql | ...
dbUrl: 'app.db', // database URL
});