Command Line Tools
Wheels CLI Command Reference
Wheels CLI Command Reference
Section titled “Wheels CLI Command Reference”Complete reference for all Wheels CLI commands organized by category.
Quick Reference
Section titled “Quick Reference”Most Common Commands
Section titled “Most Common Commands”| Command | Description |
|---|---|
wheels generate app [name] | Create new application |
wheels generate scaffold [name] | Generate complete CRUD |
wheels dbmigrate latest | Run database migrations |
wheels test run | Run application tests |
wheels reload | Reload application |
Core Commands
Section titled “Core Commands”Essential commands for managing your Wheels application.
-
wheels init- Bootstrap existing app for CLI Documentation -
wheels info- Display version information Documentation -
wheels reload- Reload application Documentation -
wheels deps- Manage dependencies Documentation -
wheels destroy [type] [name]- Remove generated code Documentation
Code Generation
Section titled “Code Generation”Commands for generating application code and resources.
-
wheels generate app(alias:wheels new) - Create new application Documentation -
wheels generate app-wizard- Interactive app creation Documentation -
wheels generate controller(alias:wheels g controller) - Generate controller Documentation -
wheels generate model(alias:wheels g model) - Generate model Documentation -
wheels generate view(alias:wheels g view) - Generate view Documentation -
wheels generate helper(alias:wheels g helper) - Generate global helper functions Documentation -
wheels generate migration(alias:wheels g migration) - Generate database migration Documentation -
wheels generate property- Add model property Documentation -
wheels generate route- Generate route Documentation -
wheels generate test- Generate tests Documentation -
wheels generate code- Code snippets Documentation -
wheels generate snippets- Snippets Template Documentation -
wheels generate scaffold- Complete CRUD Documentation -
wheels generate api-resource- Generate RESTful API resource Documentation
Generator Options
Section titled “Generator Options”Common options across generators:
--force- Overwrite existing files--help- Show command help
Database Commands
Section titled “Database Commands”Commands for managing database schema and migrations.
Database Operations
Section titled “Database Operations”-
wheels db create- Create database Documentation -
wheels db drop- Drop database Documentation
Migration Management
Section titled “Migration Management”-
wheels dbmigrate info- Show migration status Documentation -
wheels dbmigrate latest- Run all pending migrations Documentation -
wheels dbmigrate up- Run next migration Documentation -
wheels dbmigrate down- Rollback last migration Documentation -
wheels dbmigrate reset- Reset all migrations Documentation -
wheels dbmigrate exec [version]- Run specific migration Documentation
Migration Creation
Section titled “Migration Creation”-
wheels dbmigrate create blank [name]- Create empty migration Documentation -
wheels dbmigrate create table [name]- Create table migration Documentation -
wheels dbmigrate create column [table] [column]- Add column migration Documentation -
wheels dbmigrate remove table [name]- Drop table migration Documentation
Testing Commands
Section titled “Testing Commands”Commands for running and managing tests.
-
wheels test run- Run tests Documentation -
wheels test all- Run all tests Documentation -
wheels test coverage- Run coverage tests Documentation -
wheels test integration- Run integration tests Documentation -
wheels test unit- Run unit tests Documentation -
wheels test watch- Rerun tests on any change Documentation
Environment Management
Section titled “Environment Management”Commands for managing development environments and application context.
-
wheels env setup [name]- Setup environment Documentation -
wheels env list- List environments Documentation -
wheels env merge- Merge env files Documentation -
wheels env set- Set env variable Documentation -
wheels env show- Show env variables Documentation -
wheels env switch- Switch between environments Documentation -
wheels env validate- Validate environment configuration Documentation
Code Analysis
Section titled “Code Analysis”Commands for analyzing code quality and patterns.
-
wheels analyze code- Analyze code quality Documentation -
wheels analyze performance- Performance analysis Documentation -
wheels analyze security- Security analysis Documentation
Config Commands
Section titled “Config Commands”Commands for managing application configuration.
-
wheels config check- Check configuration validity Documentation -
wheels config diff- Compare configuration differences Documentation -
wheels config dump- Dump current configuration Documentation
Docker Commands
Section titled “Docker Commands”Commands for Docker container management and deployment.
-
wheels docker init- Initialize Docker configuration files Documentation -
wheels docker build- Build Docker images Documentation -
wheels docker deploy- Build and deploy Docker containers Documentation -
wheels docker push- Push Docker images to registries Documentation -
wheels docker login- Authenticate with container registries Documentation -
wheels docker logs- View container logs Documentation -
wheels docker exec- Execute commands in containers Documentation -
wheels docker stop- Stop Docker containers Documentation
Get Commands
Section titled “Get Commands”Commands for retrieving application information.
-
wheels get environment- Get current environment details Documentation -
wheels get settings- Get application settings Documentation
Documentation Commands
Section titled “Documentation Commands”Commands for generating and serving project documentation.
-
wheels docs generate- Generate project documentation Documentation -
wheels docs serve- Serve documentation locally Documentation
Plugin Commands
Section titled “Plugin Commands”Commands for managing Wheels plugins.
-
wheels plugin install- Install a plugin Documentation -
wheels plugin list- List installed plugins Documentation -
wheels plugin search- Search for plugins Documentation -
wheels plugin info- Show plugin information Documentation -
wheels plugin outdated- Check for outdated plugins Documentation -
wheels plugin update- Update a plugin Documentation -
wheels plugin update:all- Update all plugins Documentation -
wheels plugin remove- Remove a plugin Documentation -
wheels plugin init- Initialize new plugin Documentation
Command Patterns
Section titled “Command Patterns”Command Aliases
Section titled “Command Aliases”Many commands have shorter aliases:
wheels g controller users # Same as: wheels generate controller userswheels g model user # Same as: wheels generate model userwheels g helper format # Same as: wheels generate helper formatwheels g migration CreateUsers # Same as: wheels generate migration CreateUserswheels new myapp # Same as: wheels generate app myappCommon Workflows
Section titled “Common Workflows”Creating a new feature:
wheels generate scaffold name=product properties=name:string,price:decimalwheels dbmigrate latestwheels test runStarting development:
wheels reload # Reload the applicationwheels test run # Run testsDeployment preparation:
wheels test runwheels analyze securitywheels analyze performancewheels dbmigrate infoEnvironment Variables
Section titled “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
Section titled “Exit Codes”| Code | Description |
|---|---|
0 | Success |
1 | General error |
2 | Invalid arguments |
3 | File not found |
4 | Permission denied |
5 | Database error |