Reference

CLI Commands

CanxJS provides a powerful CLI to help you scaffold, develop, and maintain your applications.

Quick Start

Create and run your first CanxJS application in seconds.

Terminal

# Create a new project
bunx create-canx my-app
# Navigate to project
cd my-app
# Install dependencies
bun install
# Start development server
bun run dev

All Commands

Project Creation

$ bunx create-canx my-app

Create a new CanxJS project with the default MVC template

$ bunx create-canx my-app --type=api

Create an API-only project without views

$ bunx create-canx my-app --type=microservice

Create a minimal microservice setup

$ bunx create-canx my-app --language=typescript

Create project with TypeScript (default)

Development

$ bun run dev

Start development server with hot reload

$ bun run build

Build for production

$ bun run start

Start production server (NODE_ENV=production)

$ bun test

Run the test suite with Bun's test runner

$ bunx canx tinker

Interact with your application in REPL mode

Database

$ bun run migrate

Run pending migrations

$ bun run migrate:rollback

Rollback the last batch of migrations

$ bun run migrate:fresh

Drop all tables and re-run all migrations

$ bun run migrate:status

Show the status of each migration

$ bunx canx make:migration CreateUsersTable

Create a new migration file (PascalCase name)

$ bunx canx make:seeder UserSeeder

Create a new seeder file

Generators

$ bun run make:controller UserController

Create a new controller

$ bun run make:model User

Create a new model

$ bunx canx make:middleware Auth

Create a new middleware

$ bun run canx make:microservice PaymentService

Generate a new microservice boilerplate

$ bun run canx make:cqrs-command CreateOrder

Generate a new CQRS Command and Handler

Utilities

$ bunx canx list

List all available CLI commands

$ bunx canx optimize

Optimize framework for production (clear caches, etc)

$ bunx canx schedule:run

Run scheduled tasks manually

$ bunx canx route:list

List all registered routes

$ bunx canx down

Put the application into maintenance mode (canx up to restore)

Generator Example

The CLI generators create boilerplate code for you, following CanxJS conventions.

Terminal

# Create a controller
bun run make:controller UserController
# Creates: src/controllers/UserController.ts
# With basic CRUD methods: index, show, store, update, destroy

Next Steps

Learn more about the CanxJS API and how to use it in your applications.

Reference

CLI Commands

CanxJS provides a powerful CLI to help you scaffold, develop, and maintain your applications.

Quick Start

Create and run your first CanxJS application in seconds.

Terminal

# Create a new project
bunx create-canx my-app
# Navigate to project
cd my-app
# Install dependencies
bun install
# Start development server
bun run dev

All Commands

Project Creation

$ bunx create-canx my-app

Create a new CanxJS project with the default MVC template

$ bunx create-canx my-app --type=api

Create an API-only project without views

$ bunx create-canx my-app --type=microservice

Create a minimal microservice setup

$ bunx create-canx my-app --language=typescript

Create project with TypeScript (default)

Development

$ bun run dev

Start development server with hot reload

$ bun run build

Build for production

$ bun run start

Start production server (NODE_ENV=production)

$ bun test

Run the test suite with Bun's test runner

$ bunx canx tinker

Interact with your application in REPL mode

Database

$ bun run migrate

Run pending migrations

$ bun run migrate:rollback

Rollback the last batch of migrations

$ bun run migrate:fresh

Drop all tables and re-run all migrations

$ bun run migrate:status

Show the status of each migration

$ bunx canx make:migration CreateUsersTable

Create a new migration file (PascalCase name)

$ bunx canx make:seeder UserSeeder

Create a new seeder file

Generators

$ bun run make:controller UserController

Create a new controller

$ bun run make:model User

Create a new model

$ bunx canx make:middleware Auth

Create a new middleware

$ bun run canx make:microservice PaymentService

Generate a new microservice boilerplate

$ bun run canx make:cqrs-command CreateOrder

Generate a new CQRS Command and Handler

Utilities

$ bunx canx list

List all available CLI commands

$ bunx canx optimize

Optimize framework for production (clear caches, etc)

$ bunx canx schedule:run

Run scheduled tasks manually

$ bunx canx route:list

List all registered routes

$ bunx canx down

Put the application into maintenance mode (canx up to restore)

Generator Example

The CLI generators create boilerplate code for you, following CanxJS conventions.

Terminal

# Create a controller
bun run make:controller UserController
# Creates: src/controllers/UserController.ts
# With basic CRUD methods: index, show, store, update, destroy

Next Steps

Learn more about the CanxJS API and how to use it in your applications.