Skip to content
v4.0
current
v4.0
current
v3.0.0
archived
v2.5.0
archived
Search
Ctrl
K
Cancel
Home
Guides
API
Blog
Packages
GitHub
↗
Switch version
v4.0
current
v3.0.0
archived
v2.5.0
archived
Overview
v4.0 (current)
Start Here
Welcome to Wheels
Why Wheels?
Install Wheels
Choosing Your Tooling
Installing Wheels
Installing with CommandBox
Manual Installation (zip / GitHub)
CFML Engines
Working Without the CLI
Anatomy of a Wheels App
Your First 15 Minutes
Tutorial: Build a Blog
Overview
1. Hello, Wheels
2. Your First Model
3. CRUD Scaffold
4. Validations + Turbo Frames
5. Comments + Turbo Streams
6. Authentication
7. Testing + Deploying
8. Bonus: wheels-basecoat
Upgrading & Releases
What's New in 4.0
Upgrading from 3.x to 4.0
Upgrading Without the CLI
Upgrading from 2.x to 3.x
Performance Notes for 2.x Upgraders
Release Channels
Reading the Changelog
Core Concepts
The Request Lifecycle
MVC in Wheels
Conventions over Configuration
ORM Philosophy
The Dependency Injection Container
Middleware Pipeline
How Routing Works
Environments and Configuration
The Basics
Routing
Controllers and Actions
Views, Layouts, Partials
Forms and Form Helpers
Validation and Error Display
Models and the ORM
Associations
Migrations
Seeding
Shared Development Databases
Query Builder and Scopes
Database and Multiple Datasources
Digging Deeper
Authentication Patterns
Authorization & Filters
Authorization Policies
Background Jobs
Caching
Sending Email
File Uploads & Downloads
Server-Sent Events
Channels
Internationalization
Multi-tenancy
Packages
Route Model Binding
CORS
Rate Limiting
Dependency Injection Usage
Overriding Core Methods
Debug Panel
Testing
Overview
Model Tests
Controller Tests
View & Form Tests
Integration Tests
Functional Tests
Browser Tests
Fixtures & Test Data
Running Tests Locally
CI Integration
Deployment & Operations
Production Configuration
Security Hardening
Observability and Logging
Deploy It Yourself (no CLI required)
Docker Deployment
VM and Bare-metal Deployment
IIS and Windows Deployment
URL Rewriting
wheels deploy (built-in deployer)
Your First Deploy
deploy.yml Reference
Accessories
Secrets
Hooks
Migrating from Kamal
Architecture of wheels deploy
Contributing & Project
Submitting Pull Requests
Coding Standards
Running the Framework Test Suite
Writing Documentation
wheels CLI Reference
Installation
Quick Start
Configuration
MCP Integration
Wheels Commands
Creating a Project
Code Generation
Database
Dev Server
Testing
App Inspection
Code Quality
Scaffold Cleanup
Console & REPL
Upgrade
Core Commands (LuCLI)
Server
CFML Execution
System & Secrets
Modules & Deps
AI & Completion
Packages Commands (generated reference)
Overview
packages list
packages search
packages show
packages add
packages update
packages remove
packages registry
Overview
registry info
registry refresh
Deploy Commands (generated reference)
Overview
deploy
setup
redeploy
rollback
config
init
version
audit
details
docs
remove
app
Overview
app boot
app start
app stop
app details
app containers
app images
app logs
app live
app maintenance
app remove
proxy
Overview
proxy boot
proxy reboot
proxy start
proxy stop
proxy restart
proxy details
proxy logs
proxy remove
accessory
Overview
accessory boot
accessory reboot
accessory start
accessory stop
accessory restart
accessory details
accessory logs
accessory remove
build
Overview
build deliver
build push
build pull
build create
build remove
build details
build dev
registry
Overview
registry setup
registry login
registry logout
registry remove
server
Overview
server exec
server bootstrap
prune
Overview
prune all
prune images
prune containers
lock
Overview
lock acquire
lock release
lock status
secrets
Overview
secrets fetch
secrets extract
secrets print
Glossary
v3.0.0
INTRODUCTION
Getting Started
Overview
Running Local Development Servers
Beginner Tutorial: Hello World
Beginner Tutorial: Hello Database
Tutorial: Wheels, AJAX, and You
Boxlang Support
Frameworks and Wheels
Requirements
Manual Installation
Upgrading
Overview
Config Directory Migration (3.0.0)
Screencasts
Command Line Tools
CLI Overview
Quick Start Guide
Command Reference
Overview
Core Commands
wheels init
wheels info
wheels about
wheels reload
wheels deps
wheels destroy
Code Generation
wheels generate app
wheels generate app-wizard
wheels generate controller
wheels generate model
wheels generate view
wheels generate helper
wheels generate migration
wheels generate property
wheels generate route
wheels generate test
wheels generate snippets
wheels generate code
wheels generate scaffold
wheels generate api-resource
Database Commands
Database Operations
wheels db create
wheels db drop
Migration Commands
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
Testing Commands
wheels test run
wheels advanced testing
Environment Management
wheels env setup
wheels env list
wheels env merge
wheels env set
wheels env show
wheels env switch
wheels env validate
Code Analysis
wheels analyze code
wheels analyze performance
Config
wheels config check
wheels config diff
wheels config dump
Docker Commands
wheels docker init
wheels docker build
wheels docker deploy
wheels docker push
wheels docker login
wheels docker logs
wheels docker exec
wheels docker stop
Get Commands
wheels get environment
wheels get settings
Documentation
wheels docs generate
wheels docs serve
Plugins
wheels plugin install
wheels plugin list
wheels plugin search
wheels plugin info
wheels plugin outdated
wheels plugin update
wheels plugin update:all
wheels plugin remove
wheels plugin init
Asset Management
asset management commands
CLI Development Guides
Configuration Management
Creating Commands
Service Architecture
Migrations Guide
Testing Guide
Working with Wheels
Conventions
Configuration and Defaults
Directory Structure
Switching Environments
Testing Your Application
Using the Test Environment
Overriding Core Methods
Contributing to Wheels
Contributing to Wheels VS Code Extension
Contributing to Wheels Windows Installer
Contributing to Wheels macOS Installer
Submitting Pull Requests
Documenting your Code
Handling Requests with Controllers
Request Handling
Rendering Content
Redirecting Users
Sending Files
Sending Email
Responding with Multiple Formats
Using the Flash
Using Filters
Verification
Event Handlers
Routing
URL Rewriting
Overview
Apache
IIS
Tomcat
Nginx
Obfuscating URLs
Caching
Nesting Controllers
CORS Requests
Displaying Views to Users
Pages
Partials
Linking Pages
Layouts
Form Helpers and Showing Errors
Displaying Links for Pagination
Date, Media, and Text Helpers
Creating Custom View Helpers
Localization
Database Interaction Through Models
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
Database Migrations
Overview
Migrations in Production
Using Multiple Data Sources
Using SQLite
Project Documentation
Overview
External Links
Source Code
Issue Tracker
Sponsor Us
Community
Plugins
Installing and Using Plugins
Developing Plugins
Publishing Plugins
v2.5.0
INTRODUCTION
Getting Started
Overview
Running Local Development servers
Beginner Tutorial: Hello World
Beginner Tutorial: Hello Database
Tutorial: CFWheels, AJAX, and You
Frameworks and CFWheels
Requirements
Manual Installation
Upgrading
Screencasts
Command Line Tools
CLI Commands
wheels - commands
wheels generate - commands
wheels dbmigrate - commands
wheels plugins - commands
Working with CFWheels
Conventions
Configuration and Defaults
Directory Structure
Switching Environments
Testing Your Application
Contributing to CFWheels
Documenting your Code
Handling Requests with Controllers
Request Handling
Rendering Content
Redirecting Users
Sending Files
Sending Email
Responding with Multiple Formats
Using the Flash
Using Filters
Verification
Event Handlers
Routing
URL Rewriting
Overview
Apache
IIS
Tomcat
Nginx
Obfuscating URLs
Caching
Nesting Controllers
CORS Requests
Displaying Views to Users
Pages
Partials
Linking Pages
Layouts
Form Helpers and Showing Errors
Displaying Links for Pagination
Date, Media, and Text Helpers
Creating Custom View Helpers
Localization
Database Interaction Through Models
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
Database Migrations
Overview
Migrations In Production
Using Multiple Data Sources
Plugins
Installing and Using Plugins
Developing Plugins
Publishing Plugins
External Links
Source Code
Issue Tracker
Sponsor Us
Community
Select theme
Dark
Light
Auto
Command Line Tools
wheels packages registry
Verbs for managing the local registry cache.
refresh
Bust the 24h manifest cache.
info
Print registry URL, branch, and cache state.
