Skip to content

Start Here

Installing with CommandBox

CommandBox is Ortus Solutions’ CFML package manager and server runner. Wheels publishes its framework artifacts to ForgeBox, so you can install and serve a Wheels app with box alone — no wheels CLI required.

This page exists because CommandBox-centric 2.x/3.x teams need a clear answer to one question: what is my supported workflow on Wheels 4?

In Wheels 4, CommandBox is supported as a server manager and package fetcher — and that’s the whole of it.

You want to…CommandBox?Tool
Install the framework from ForgeBoxYesbox install wheels-base-template
Run a CFML server (Lucee / Adobe CF / BoxLang)Yesbox server start
Vendor wheels-core into an existing appYesbox install wheels-core
Scaffold an app, generators, migrate, test, consoleNothe wheels CLI
The packages registry, MCP server, deployNothe wheels CLI

The short version: CommandBox gets you the framework and a running server. Reach for the wheels CLI for scaffolding — generators, wheels migrate, wheels test, wheels console, the MCP server, the packages registry, and wheels deploy. None of those run through CommandBox.

Every stable Wheels release publishes four packages to ForgeBox (see .github/workflows/release.yml):

SlugWhat it is
wheels-base-templateThe full app skeleton. Declares wheels-core as a dependency, so installing it pulls the framework into vendor/wheels/ too. Start here.
wheels-coreThe framework core only — installs into vendor/wheels/. Use it to vendor or upgrade the framework inside an existing app.
wheels-cliThe deprecated legacy CommandBox CLI module. Predates 4.0 and does not know the 4.0 commands — see below.
wheels-starter-appA pre-built sample app for demos and experiments.

All four track the current release version (4.0.x at time of writing).

  1. Install CommandBox if you don’t have it:

    illustrative — install CommandBox
    # macOS
    brew install commandbox
    # Windows
    choco install commandbox
    # Linux: see https://commandbox.ortusbooks.com/setup/installation
  2. Install the base template into an empty directory. This pulls wheels-core into vendor/wheels/ via the template’s declared installPaths:

    illustrative — box pulls from ForgeBox
    mkdir myapp && cd myapp
    box install wheels-base-template

    You’ll get the modern Wheels 4.0 layout: app/, config/, db/, public/ (the web root), tests/, a server.json, and the framework core in vendor/wheels/.

The template ships a server.json, so a server start is a one-liner from the app root:

illustrative — box server start
box server start

Pin a specific engine the same way the CFML Engines page describes — CommandBox downloads it on first use:

illustrative — pin the engine
box server start cfengine=lucee@7 # or adobe@2025, or boxlang@latest

Reload the framework after a config or code change by hitting the reload URL directly (there is no wheels reload on this path):

illustrative — reload URL
http://localhost:<port>/?reload=true&password=<your reload password>

Not supported via CommandBox: the wheels CLI feature set

Section titled “Not supported via CommandBox: the wheels CLI feature set”

CommandBox fetches and serves; it does not replace the developer CLI. The following all require the LuCLI-based wheels binary (install it from brew / scoop / apt / yum or a manual JAR):

  • Scaffoldingwheels new, and every generator (wheels generate model/controller/scaffold/...).
  • Migrationswheels migrate latest|up|down|info|doctor.
  • Testingwheels test.
  • Consolewheels console.
  • MCP serverwheels mcp wheels.
  • The packages registrywheels packages ... (first-party add-ons; not on ForgeBox).
  • Deploywheels deploy.

The 3.x getting-started spine was built on CommandBox. Here’s how each old step maps onto Wheels 4:

2.x / 3.x (CommandBox)Wheels 4
box install wheels-cliInstall the standalone wheels CLI (brew / scoop / apt / yum)
wheels generate app myApp / wheels g appwheels new myApp
box server startStill works — or wheels start (Lucee, bundled with the CLI)
ForgeBox plugins (box install ..., forgebox install)The wheels packages registry (CLI-only; not ForgeBox)
box install wheels-base-template + wheels-coreUnchanged — still the supported way to fetch the framework with CommandBox

The practical recommendation: keep CommandBox if you rely on it for Adobe CF or BoxLang server management, and add the wheels CLI alongside it for everything in the feature-set list above.