Command Reference

Complete reference for all Wheels CLI commands organized by category.

Quick Reference

Most Common Commands

Command	Description
wheels generate app [name]	Create new application
wheels scaffold [name]	Generate complete CRUD
wheels dbmigrate latest	Run database migrations
wheels test run	Run application tests
wheels server start	Start development server
wheels server status	Check server status
wheels watch	Watch files for changes
wheels reload	Reload application

Core Commands

Essential commands for managing your Wheels application.

Command	Description	Documentation
wheels init	Bootstrap existing app for CLI	Details
wheels info	Display version information	Details
wheels reload [mode]	Reload application	Details
wheels deps	Manage dependencies	Details
wheels destroy [type] [name]	Remove generated code	Details
wheels watch	Watch for file changes	Details

Server Management

Enhanced server commands that wrap CommandBox's native functionality with Wheels-specific features.

Command	Description	Documentation
wheels server	Display server commands help	Details
wheels server start	Start development server	Details
wheels server stop	Stop development server	Details
wheels server restart	Restart server and reload app	Details
wheels server status	Show server status with Wheels info	Details
wheels server log	Tail server logs	Details
wheels server open	Open application in browser	Details

Server Command Features

• Validates Wheels application directory

• Shows framework-specific information

• Integrates with application reload

• Provides helpful error messages

Code Generation

Commands for generating application code and resources.

Command	Alias	Description	Documentation
wheels generate app	wheels new	Create new application	Details
wheels generate app-wizard		Interactive app creation	Details
wheels generate controller	wheels g controller	Generate controller	Details
wheels generate model	wheels g model	Generate model	Details
wheels generate view	wheels g view	Generate view	Details
wheels generate property		Add model property	Details
wheels generate route		Generate route	Details
wheels generate resource		REST resource	Details
wheels generate api-resource		API resource (Currently broken)	Details
wheels generate frontend		Frontend code	Details
wheels generate test		Generate tests	Details
wheels generate snippets		Code snippets	Details
wheels scaffold		Complete CRUD	Details

Generator Options

Common options across generators:

• --force - Overwrite existing files

• --help - Show command help

Database Commands

Commands for managing database schema and migrations.

Migration Management

Command	Description	Documentation
wheels dbmigrate info	Show migration status	Details
wheels dbmigrate latest	Run all pending migrations	Details
wheels dbmigrate up	Run next migration	Details
wheels dbmigrate down	Rollback last migration	Details
wheels dbmigrate reset	Reset all migrations	Details
wheels dbmigrate exec [version]	Run specific migration	Details

Migration Creation

Command	Description	Documentation
wheels dbmigrate create blank [name]	Create empty migration	Details
wheels dbmigrate create table [name]	Create table migration	Details
wheels dbmigrate create column [table] [column]	Add column migration	Details
wheels dbmigrate remove table [name]	Drop table migration	Details

Database Operations

Command	Description	Documentation
wheels db schema	Export/import schema	Details
wheels db seed	Seed database	Details

Testing Commands

Commands for running and managing tests.

Command	Description	Documentation
wheels test [type]	Run framework tests	Details
wheels test run [spec]	Run TestBox tests	Details
wheels test coverage	Generate coverage report	Details
wheels test debug	Debug test execution	Details

Test Options

• --watch - Auto-run on changes

• --reporter - Output format (simple, json, junit)

• --bundles - Specific test bundles

• --labels - Filter by labels

Configuration Commands

Commands for managing application configuration.

Command	Description	Documentation
wheels config list	List configuration	Details
wheels config set [key] [value]	Set configuration	Details
wheels config env	Environment config	Details

Environment Management

Commands for managing development environments and application context.

Command	Description	Documentation
wheels environment	Display/switch environment	Details
wheels environment set [env]	Set environment with reload	Details
wheels environment list	List available environments	Details
wheels console	Interactive REPL console	Details
wheels runner [script]	Execute scripts with context	Details

Legacy Environment Commands

Command	Description	Documentation
wheels env	Environment base command	Details
wheels env setup [name]	Setup environment	Details
wheels env list	List environments	Details
wheels env switch [name]	Switch environment	Details

Plugin Management

Commands for managing Wheels plugins.

Command	Description	Documentation
wheels plugins	Plugin management base command	Details
wheels plugins list	List plugins	Details
wheels plugins install [name]	Install plugin	Details
wheels plugins remove [name]	Remove plugin	Details

Plugin Options

• --global - Install/list globally

• --dev - Development dependency

Code Analysis

Commands for analyzing code quality and patterns.

Command	Description	Documentation
wheels analyze	Code analysis base command	Details
wheels analyze code	Analyze code quality	Details
wheels analyze performance	Performance analysis	Details
wheels analyze security	Security analysis (deprecated)	Details

Security Commands

Commands for security scanning and hardening.

Command	Description	Documentation
wheels security	Security management base command	Details
wheels security scan	Scan for vulnerabilities	Details

Security Options

• --fix - Auto-fix issues

• --path - Specific path to scan

Performance Commands

Commands for optimizing application performance.

Command	Description	Documentation
wheels optimize	Optimization base command	Details
wheels optimize performance	Optimize application	Details

Documentation Commands

Commands for generating and serving documentation.

Command	Description	Documentation
wheels docs	Documentation base command (Currently broken)	Details
wheels docs generate	Generate documentation	Details
wheels docs serve	Serve documentation	Details

Documentation Options

• --format - Output format (html, markdown)

• --output - Output directory

• --port - Server port

Maintenance Commands

Commands for managing application maintenance mode and cleanup tasks.

Command	Description	Documentation
wheels maintenance:on	Enable maintenance mode	Details
wheels maintenance:off	Disable maintenance mode	Details
wheels cleanup:logs	Remove old log files	Details
wheels cleanup:tmp	Remove temporary files	Details
wheels cleanup:sessions	Remove expired sessions	Details

Maintenance Options

• --force - Skip confirmation prompts

• --dryRun - Preview changes without executing

CI/CD Commands

Commands for continuous integration and deployment workflows.

Command	Description	Documentation
wheels ci init	Initialize CI/CD configuration	Details

Docker Commands

Commands for Docker container management and deployment.

Command	Description	Documentation
wheels docker init	Initialize Docker configuration	Details
wheels docker deploy	Deploy using Docker	Details

Deployment Commands

Commands for managing application deployments.

Command	Description	Documentation
wheels deploy	Deployment base command	Details
wheels deploy audit	Audit deployment configuration	Details
wheels deploy exec	Execute deployment	Details
wheels deploy hooks	Manage deployment hooks	Details
wheels deploy init	Initialize deployment	Details
wheels deploy lock	Lock deployment state	Details
wheels deploy logs	View deployment logs	Details
wheels deploy proxy	Configure deployment proxy	Details
wheels deploy push	Push deployment	Details
wheels deploy rollback	Rollback deployment	Details
wheels deploy secrets	Manage deployment secrets	Details
wheels deploy setup	Setup deployment environment	Details
wheels deploy status	Check deployment status	Details
wheels deploy stop	Stop deployment	Details

Deployment Options

• --environment - Target environment

• --force - Force deployment

• --dry-run - Preview changes without deploying

Command Patterns

Getting Help

Every command supports --help:

wheels [command] --help
wheels generate controller --help
wheels dbmigrate create table --help

Command Aliases

Many commands have shorter aliases:

wheels g controller users  # Same as: wheels generate controller users
wheels g model user       # Same as: wheels generate model user
wheels new myapp         # Same as: wheels generate app myapp

Common Workflows

Creating a new feature:

wheels scaffold name=product properties=name:string,price:decimal
wheels dbmigrate latest
wheels test run

Starting development:

wheels server start      # Start the server
wheels watch            # Terminal 1: Watch for file changes
wheels server log       # Terminal 2: Monitor logs
wheels test run --watch # Terminal 3: Run tests in watch mode

Deployment preparation:

wheels test run
wheels security scan
wheels optimize performance
wheels dbmigrate info
wheels environment production

Interactive debugging:

wheels console                    # Start REPL
wheels console environment=testing # Test in specific env
wheels console execute="model('User').count()"  # Quick check

Running maintenance scripts:

wheels runner scripts/cleanup.cfm
wheels runner scripts/migrate.cfm environment=production
wheels runner scripts/report.cfm params='{"month":12}'

Environment Variables

Variable	Description	Default
WHEELS_ENV	Environment mode	development
WHEELS_DATASOURCE	Database name	From config
WHEELS_RELOAD_PASSWORD	Reload password	From config

Exit Codes

Code	Description
0	Success
1	General error
2	Invalid arguments
3	File not found
4	Permission denied
5	Database error

Command Status Notes

Some commands in the Wheels CLI are currently in various states of development or maintenance:

Broken Commands

• wheels docs - Base documentation command is currently broken

• wheels generate api-resource - API resource generation is currently broken

Disabled Commands

The following commands exist in the codebase but are currently disabled:

• Some CI and Docker commands have disabled variants in the codebase

These commands may be re-enabled in future versions of Wheels.

See Also

• Installation Guide

• Quick Start Guide

• Creating Custom Commands

• CLI Architecture