Loading...

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

Ask or search...
Ctrl K
Loading...

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:

๐Ÿš€ 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

Best Practices

๐Ÿ“‹ Reference

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

  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

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

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.