Wheels CLI Documentation

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.
• 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:

# Reload application
wheels reload development

# Analyze code
wheels analyze code
wheels security scan

Getting Started

1. 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

2. Install Wheels CLI:

   box install wheels-cli

3. Create Your First App:

   wheels new myapp
   cd myapp
   box server start

4. 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.