BoxLang 🚀 A New JVM Dynamic Language Learn More...

Wheels CLI Commands

v3.0.0-SNAPSHOT+791 CommandBox Modules

Wheels CLI

The official Command Line Interface for the wheels framework.

Installation

Install the Wheels CLI module via CommandBox:

box install wheels-cli

Features

  • Code Generation - Generate applications, controllers, models, views, and complete scaffolds
  • Database Migrations - Version control your database schema with migrations
  • Testing - Run tests with coverage reports and debugging capabilities
  • Development Tools - File watching, reloading, and environment management
  • Deployment - Docker integration and CI/CD configuration

Quick Start

Create a new Wheels application:

wheels new myapp

Generate a complete resource:

wheels scaffold Product name:string price:decimal description:text

Run database migrations:

wheels dbmigrate latest

Documentation

Full documentation is available at: https://guides.wheels.org/docs/command-line-tools/cli-commands

Requirements

  • CommandBox 5.0+
  • wheels 3.0+

License

Apache License 2.0

Pull Request Instructions

Pull Request Title

Implement CLI improvements from CLI-IMPROVEMENTS.md

Pull Request Description

Summary

  • Implemented all CLI improvements recommended in CLI-IMPROVEMENTS.md
  • Added 10 new command groups with various subcommands to enhance developer workflow
  • Added comprehensive documentation for all new and existing commands
  • All commands follow existing project structure and patterns

Changes include

  1. Interactive Development Mode: Added wheels watch command to monitor file changes and automatically reload
  2. Enhanced Testing Tools: Added wheels test:coverage and wheels test:debug commands
  3. API Development Support: Added wheels generate api-resource command
  4. Modern Frontend Integration: Added wheels generate frontend command supporting React, Vue, and Alpine.js
  5. Configuration Management: Added wheels config:list, wheels config:set, and wheels config:env commands
  6. Dependency Management: Added wheels deps command with multiple actions
  7. Performance Analysis: Added wheels analyze command to identify bottlenecks
  8. Database Tools: Added wheels db:seed and wheels db:schema commands
  9. CI/CD Templates: Added wheels ci:init command for GitHub Actions, GitLab CI, and Jenkins
  10. Docker Workflow: Added wheels docker:init and wheels docker:deploy commands

Documentation

Added comprehensive documentation in the docs/ directory covering all CLI commands and best practices.

Test plan

  1. Test each new command individually
  2. Verify integration with existing wheels commands
  3. Ensure backward compatibility with existing functionality

To create this pull request manually:

  1. Go to: https://github.com/wheels-dev/wheels/pulls
  2. Click "New pull request"
  3. Select the source branch: "feature/cli-improvements"
  4. Select the target branch: "main"
  5. Copy and paste the above title and description
  6. Click "Create pull request"

0.5.0

  • app-wizard command [Peter Amiri]
  • Better h2 integration [Peter Amiri]

0.4.2

  • Adds create app command [Peter Amiri]
  • Adds basic support for templates [Peter Amiri]

0.2.9

  • Removes cfprocessdirective from default bootstrap layout

0.2.8

  • Fixes Scaffolding edit routing

0.2.5

  • Updates new installation bootstrap flash messages plugin #25 [Peter Amiri, Tom King]
  • New Properties added via scaffold now appear in the default index #24 [Peter Amiri]
  • Fixes Index templates to use routes and buttonTo Delete Links [Tom King]
  • Fixes Encode Attributes as bootstrap template default to form helpers [Tom King]

0.2.4

  • Various scaffolding syntax updates for Wheels 2.0

0.2.2

  • Adds Wheels 2.0

0.1.6

  • Add travis Adapter Test

0.1.4

Enhancements

  • Drops wheels 1.x support
  • Core, App and plugin tests via wheels test core servername etc added
  • Restructures Test.cf into single command vs three
  • Removes old plugins

0.1.1

Enhancements

  • Adds command aliases for dbmigrate (db), generate(g), destroy(d) #15
  • CLI can identify Wheels version from box.json #16
  • wheels reload (alias r) command added #20
  • wheels new now offers and configures a H2 database for development when on lucee #19
  • wheels init allows for existing Wheels apps to be prepped for CLI usage #21

Bug Fixes

  • wheels new now downloads to a unique temp folder #11
  • wheels scaffold and wheels g property command now prompt for migration #13
  • generated columns are now lowercase #18
  • CLI now only installs dbmigrate + dbmigratebridge plugins for wheels 1.x #22
  • Special Chars now stripped for generate and new commands #17

$ box install wheels-cli

No collaborators yet.
     
  • {{ getFullDate("2024-03-26T14:56:47Z") }}
  • {{ getFullDate("2025-06-11T23:35:10Z") }}
  • 1,088
  • 3,460