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 generate scaffold [name]
Generate complete CRUD
wheels dbmigrate latest
Run database migrations
wheels test
Run application tests
wheels reload
Reload application
Core Commands
Essential commands for managing your Wheels application.
Code Generation
Commands for generating application code and resources.
Generator Options
Common options across generators:
--force
- Overwrite existing files--help
- Show command help
Database Commands
Commands for managing database schema and migrations.
Database Operations
Migration Management
Migration Creation
Testing Commands
Commands for running and managing tests.
wheels test
Run framework tests
Details
Environment Management
Commands for managing development environments and application context.
Code Analysis
Commands for analyzing code quality and patterns.
CI/CD Commands
Commands for continuous integration and deployment workflows.
Docker Commands
Commands for Docker container management and deployment.
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 generate scaffold name=product properties=name:string,price:decimal
wheels dbmigrate latest
wheels test
Starting development:
wheels reload # Reload the application
wheels test # Run tests
Deployment preparation:
wheels test
wheels analyze security
wheels analyze performance
wheels dbmigrate info
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
See Also
Last updated
Was this helpful?