Skip to content

Latest commit

 

History

History

README.md

Wheels CLI

The wheels command is a Rails-inspired CLI for scaffolding and running Wheels applications. In 4.0 it is distributed as a Homebrew / Chocolatey formula that bundles LuCLI, so no CommandBox installation is required.

Install

macOS / Linux (Homebrew):

brew tap wheels-dev/wheels
brew install wheels

Windows (Chocolatey):

choco install wheels

Both installers depend only on Java 21, which is pulled in automatically.

Commands

See the CLI command guides or run wheels --help in your terminal.

Template Customization

The CLI supports template customization through an override system. Templates placed in your application's /app/snippets/ directory will override the default CLI templates in /cli/templates/.

This allows you to:

  • Customize generated code to match your project's coding standards
  • Use your preferred CSS framework markup (Bootstrap, Tailwind, etc.)
  • Add project-specific boilerplate code
  • Maintain consistency across generated files

To customize a template:

  1. Copy the template from /cli/templates/ to /app/snippets/
  2. Modify it to match your needs
  3. The CLI will automatically use your custom template

See the Template System Guide for detailed documentation.