CLI Overview
Quick Start Guide
wheels info
wheels reload
wheels deps
wheels destroy
wheels watch
wheels generate app
wheels generate app-wizard
wheels generate controller
wheels generate model
wheels generate view
wheels generate property
wheels generate route
wheels generate resource
wheels generate api-resource
wheels generate frontend
wheels generate test
wheels generate snippets
wheels scaffold
wheels db create
wheels db drop
wheels db setup
wheels db reset
wheels db status
wheels db version
wheels db rollback
wheels db seed
wheels db dump
wheels db restore
wheels db shell
wheels db schema
wheels dbmigrate info
wheels dbmigrate latest
wheels dbmigrate up
wheels dbmigrate down
wheels dbmigrate reset
wheels dbmigrate exec
wheels dbmigrate create blank
wheels dbmigrate create table
wheels dbmigrate create column
wheels dbmigrate remove table
wheels test
wheels test run
wheels test coverage
wheels test debug
wheels config list
wheels config set
wheels config env
wheels env
wheels env setup
wheels env list
wheels env switch
wheels environment
wheels console
wheels runner
wheels server
wheels server start
wheels server stop
wheels server restart
wheels server status
wheels server log
wheels server open
wheels plugins
wheels plugins list
wheels plugins install
wheels plugins remove
wheels analyze
wheels analyze code
wheels analyze performance
wheels analyze security
wheels security
wheels security scan
wheels optimize
wheels optimize performance
wheels docs
wheels docs generate
wheels docs serve
wheels ci init
wheels docker init
wheels docker deploy
wheels deploy
wheels deploy audit
wheels deploy exec
wheels deploy hooks
wheels deploy init
wheels deploy lock
wheels deploy logs
wheels deploy proxy
wheels deploy push
wheels deploy rollback
wheels deploy secrets
wheels deploy setup
wheels deploy status
wheels deploy stop
Configuration Management
Creating Commands
Service Architecture
Migrations Guide
Testing Guide
Object Relational Mapping
Creating Records
Reading Records
Updating Records
Deleting Records
Column Statistics
Dynamic Finders
Getting Paginated Data
Associations
Nested Properties
Object Validation
Object Callbacks
Calculated Properties
Transactions
Dirty Records
Soft Delete
Automatic Time Stamps
Using Multiple Data Sources
Wheels CLI Documentation
Welcome to the comprehensive documentation for the Wheels CLI - a powerful command-line interface for the Wheels framework.
What is Wheels CLI?
Wheels CLI is a CommandBox module that provides a comprehensive set of tools for developing Wheels applications. It offers:
- Code Generation - Quickly scaffold models, controllers, views, and complete CRUD operations
- Database Migrations - Manage database schema changes with version control
- Testing Tools - Run tests, generate coverage reports, and use watch mode
- Development Tools - File watching, automatic reloading, and development servers
- Code Analysis - Security scanning, performance analysis, and code quality checks
- Plugin Management - Install and manage Wheels plugins
- Environment Management - Switch between development, testing, and production
Documentation Structure
๐ Command Reference
Complete reference for all CLI commands organized by category:
- Core Commands - Essential commands like init, reload, watch
- Code Generation - Generate applications, models, controllers, views
- Database Commands - Complete database management and migrations
- Testing Commands - Run tests and generate coverage
- Configuration - Manage application settings
- And more...
๐ Quick Start Guide
Get up and running with Wheels CLI in minutes. Learn how to:
- Install Wheels CLI
- Create your first application
- Generate CRUD scaffolding
- Run tests and migrations
๐ Guides
Development Guides
- Service Architecture - Understand the CLI's architecture
- Creating Custom Commands - Extend the CLI with your own commands
- Template System - Customize code generation templates
- Testing Guide - Write and run tests effectively
Best Practices
- Migration Guide - Database migration best practices
- Security Guide - Security scanning and hardening
- Performance Guide - Optimization techniques
๐ Reference
- Configuration Options - All available configuration settings
- Template Variables - Variables available in templates
- Exit Codes - Understanding command exit codes
- Environment Variables - Environment configuration
Key Features
๐ ๏ธ Code Generation
Generate complete applications or individual components:
# Create new application
wheels new blog
# Generate complete CRUD scaffolding
wheels scaffold name=post properties=title:string,content:text,published:boolean
# Generate individual components
wheels generate model user
wheels generate controller users --rest
wheels generate view users index
๐๏ธ Database Management
Complete database lifecycle management:
# Database operations
wheels db create # Create database
wheels db setup # Create + migrate + seed
wheels db reset # Drop + recreate + migrate + seed
wheels db shell # Interactive database shell
wheels db dump # Backup database
wheels db restore backup.sql # Restore from backup
# Migrations
wheels dbmigrate create table posts
wheels dbmigrate latest
wheels db status # Check migration status
wheels db rollback # Rollback migrations
๐งช Testing
Comprehensive testing support:
# Run all tests
wheels test run
# Advanced testing with TestBox CLI
wheels test:all # Run all tests
wheels test:unit # Run unit tests only
wheels test:integration # Run integration tests only
wheels test:watch # Watch mode
wheels test:coverage # Generate coverage reports
๐ Development Tools
Enhance your development workflow:
# Watch for file changes
wheels watch
# Reload application
wheels reload development
# Analyze code
wheels analyze code
wheels security scan
Getting Started
-
Install CommandBox (if not already installed):
# macOS/Linux curl -fsSl https://downloads.ortussolutions.com/debs/gpg | sudo apt-key add - or brew install commandbox # Windows choco install commandbox
-
Install Wheels CLI:
box install wheels-cli
-
Create Your First App:
wheels new myapp cd myapp box server start
-
Explore Commands:
wheels --help wheels generate --help wheels dbmigrate --help
Version Compatibility
| Wheels CLI | Wheels | CommandBox | CFML Engine | |------------|----------|------------|-------------| | 3.0.x | 2.5+ | 5.0+ | Lucee 5.3+, Adobe 2018+ | | 2.0.x | 2.0-2.4 | 4.0+ | Lucee 5.2+, Adobe 2016+ |
Community & Support
- Documentation: https://wheels.dev/docs
- GitHub: https://github.com/wheels-dev/wheels
- Slack: CFML Slack - #wheels channel
- Forums: https://groups.google.com/forum/#!forum/wheels
Contributing
We welcome contributions! See our Contributing Guide for details on:
- Reporting issues
- Suggesting features
- Submitting pull requests
- Creating custom commands
Recent Updates
Version 3.0.0
- ๐ Modernized service architecture
- ๐ Enhanced testing capabilities with watch mode
- ๐ Security scanning and performance optimization
- ๐ Plugin and environment management
- ๐ Improved code generation with more options
- ๐ง Better error handling and user feedback
- ๐ Comprehensive documentation
Quick Links
- All Commands - Complete command reference
- Quick Start - Get started in minutes
- Creating Commands - Extend the CLI
- Service Architecture - Technical deep dive
- Testing Guide - Testing best practices
License
Wheels CLI is open source software licensed under the Apache License 2.0. See LICENSE for details.
Ready to get started? Head to the Quick Start Guide or explore the Command Reference.
- What is Wheels CLI?
- Documentation Structure
- ๐ Command Reference
- ๐ Quick Start Guide
- ๐ Guides
- ๐ Reference
- Key Features
- ๐ ๏ธ Code Generation
- ๐๏ธ Database Management
- ๐งช Testing
- ๐ Development Tools
- Getting Started
- Version Compatibility
- Community & Support
- Contributing
- Recent Updates
- Version 3.0.0
- Quick Links
- License