Command Reference
Complete reference for all Wheels CLI commands organized by category.
Quick Reference
Most Common Commands
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 watch
Watch files for changes
wheels reload
Reload application
Core Commands
Essential commands for managing your Wheels application.
wheels init
Bootstrap existing app for CLI
wheels info
Display version information
wheels reload [mode]
Reload application
wheels deps
Manage dependencies
wheels destroy [type] [name]
Remove generated code
wheels watch
Watch for file changes
Code Generation
Commands for generating application code and resources.
wheels generate app
wheels new
Create new application
wheels generate app-wizard
Interactive app creation
wheels generate controller
wheels g controller
Generate controller
wheels generate model
wheels g model
Generate model
wheels generate view
wheels g view
Generate view
wheels generate property
Add model property
wheels generate route
Generate route
wheels generate resource
REST resource
wheels generate api-resource
API resource (Currently broken)
wheels generate frontend
Frontend code
wheels generate test
Generate tests
wheels generate snippets
Code snippets
wheels scaffold
Complete CRUD
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
wheels dbmigrate info
Show migration status
wheels dbmigrate latest
Run all pending migrations
wheels dbmigrate up
Run next migration
wheels dbmigrate down
Rollback last migration
wheels dbmigrate reset
Reset all migrations
wheels dbmigrate exec [version]
Run specific migration
Migration Creation
wheels dbmigrate create blank [name]
Create empty migration
wheels dbmigrate create table [name]
Create table migration
wheels dbmigrate create column [table] [column]
Add column migration
wheels dbmigrate remove table [name]
Drop table migration
Database Operations
wheels db schema
Export/import schema
wheels db seed
Seed database
Testing Commands
Commands for running and managing tests.
wheels test [type]
Run framework tests
wheels test run [spec]
Run TestBox tests
wheels test coverage
Generate coverage report
wheels test debug
Debug test execution
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.
wheels config list
List configuration
wheels config set [key] [value]
Set configuration
wheels config env
Environment config
Environment Management
Commands for managing development environments.
wheels env
Environment management base command
wheels env setup [name]
Setup environment
wheels env list
List environments
wheels env switch [name]
Switch environment
Plugin Management
Commands for managing Wheels plugins.
wheels plugins
Plugin management base command
wheels plugins list
List plugins
wheels plugins install [name]
Install plugin
wheels plugins remove [name]
Remove plugin
Plugin Options
--global- Install/list globally--dev- Development dependency
Code Analysis
Commands for analyzing code quality and patterns.
wheels analyze
Code analysis base command
wheels analyze code
Analyze code quality
wheels analyze performance
Performance analysis
wheels analyze security
Security analysis (deprecated)
Security Commands
Commands for security scanning and hardening.
wheels security
Security management base command
wheels security scan
Scan for vulnerabilities
Security Options
--fix- Auto-fix issues--path- Specific path to scan
Performance Commands
Commands for optimizing application performance.
wheels optimize
Optimization base command
wheels optimize performance
Optimize application
Documentation Commands
Commands for generating and serving documentation.
wheels docs
Documentation base command (Currently broken)
wheels docs generate
Generate documentation
wheels docs serve
Serve documentation
Documentation Options
--format- Output format (html, markdown)--output- Output directory--port- Server port
CI/CD Commands
Commands for continuous integration and deployment workflows.
wheels ci init
Initialize CI/CD configuration
Docker Commands
Commands for Docker container management and deployment.
wheels docker init
Initialize Docker configuration
wheels docker deploy
Deploy using Docker
Deployment Commands
Commands for managing application deployments.
wheels deploy
Deployment base command
wheels deploy audit
Audit deployment configuration
wheels deploy exec
Execute deployment
wheels deploy hooks
Manage deployment hooks
wheels deploy init
Initialize deployment
wheels deploy lock
Lock deployment state
wheels deploy logs
View deployment logs
wheels deploy proxy
Configure deployment proxy
wheels deploy push
Push deployment
wheels deploy rollback
Rollback deployment
wheels deploy secrets
Manage deployment secrets
wheels deploy setup
Setup deployment environment
wheels deploy status
Check deployment status
wheels deploy stop
Stop deployment
Deployment Options
--environment- Target environment--force- Force deployment--dry-run- Preview changes without deploying
Command Patterns
Getting Help
Every command supports --help:
Command Aliases
Many commands have shorter aliases:
Common Workflows
Creating a new feature:
Starting development:
Deployment preparation:
Environment Variables
WHEELS_ENV
Environment mode
development
WHEELS_DATASOURCE
Database name
From config
WHEELS_RELOAD_PASSWORD
Reload password
From config
Exit Codes
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 brokenwheels 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
Last updated
Was this helpful?