BoxLang ๐Ÿš€ A New JVM Dynamic Language Learn More...

ColdBox CLI

v7.8.0+14 CommandBox Modules

ColdBox CLI


ColdBox Snapshots Total Downloads Latest Stable Version Apache2 License

Copyright Since 2005 ColdBox Platform by Luis Majano and Ortus Solutions, Corp
www.coldbox.org | www.ortussolutions.com


This is the official ColdBox CLI for CommandBox. It is a collection of commands to help you work with ColdBox and its ecosystem for building, testing, and deploying BoxLang and CFML applications. It provides commands for scaffolding applications, creating tests, modules, models, views, and much more.

License

Apache License, Version 2.0.

ColdBox CLI Versions

The CLI also matches the major version of ColdBox. If you are using ColdBox 7, then you should use CLI @7. This is to ensure that you are using the correct commands for your version of ColdBox.

System Requirements

  • CommandBox 5.5+

Installation

Install the commands via CommandBox like so:

box install coldbox-cli

Usage

The ColdBox CLI provides powerful scaffolding and development tools for both CFML and BoxLang applications. All commands support the --help flag for detailed information.

๐Ÿ“ฑ Application Creation

Create new ColdBox applications from various templates:

# Create a basic ColdBox app
coldbox create app myApp

# Create with specific templates
coldbox create app myApp skeleton=modern
coldbox create app myApp skeleton=boxlang
coldbox create app myApp skeleton=rest
coldbox create app myApp skeleton=elixir

# Create with migrations support
coldbox create app myApp --migrations

# Interactive app wizard
coldbox create app-wizard

Available Templates: default, boxlang, modern, rest, elixir

๐ŸŽฏ Handlers (Controllers)

Generate MVC handlers with actions and optional views:

# Basic handler
coldbox create handler myHandler

# Handler with specific actions
coldbox create handler users index,show,edit,delete

# REST handler
coldbox create handler api/users --rest

# Resourceful handler (full CRUD)
coldbox create handler photos --resource

# Generate with views and tests
coldbox create handler users --views --integrationTests

๐Ÿ“Š Models & Services

Create domain models and business services:

# Basic model
coldbox create model User

# Model with properties and accessors
coldbox create model User properties=fname,lname,email --accessors

# Model with migration
coldbox create model User --migration

# Model with service
coldbox create model User --service

# Model with everything (service, handler, migration, seeder)
coldbox create model User --all

# Standalone service
coldbox create service UserService

๐ŸŽจ Views & Layouts

Generate view templates and layouts:

# Create a view
coldbox create view users/index

# View with helper file
coldbox create view users/show --helper

# View with content
coldbox create view welcome content="<h1>Welcome!</h1>"

# Create layout
coldbox create layout main

# Layout with content
coldbox create layout admin content="<cfoutput>#view()#</cfoutput>"

๐Ÿ”ง Resources & CRUD

Generate complete resourceful components:

# Single resource (handler, model, views, routes)
coldbox create resource photos

# Multiple resources
coldbox create resource photos,users,categories

# Custom handler name
coldbox create resource photos PhotoGallery

# With specific features
coldbox create resource users --tests --migration

๐Ÿ“ฆ Modules

Create reusable ColdBox modules:

# Create module
coldbox create module myModule

# Module with specific features
coldbox create module myModule --models --handlers --views

๐Ÿงช Testing

Generate various types of tests:

# Unit tests
coldbox create unit models.UserTest

# BDD specs
coldbox create bdd UserServiceTest

# Integration tests
coldbox create integration-test handlers.UsersTest

# Model tests
coldbox create model-test User

# Interceptor tests
coldbox create interceptor-test Security --actions=preProcess,postProcess

๐Ÿ—„๏ธ ORM & Database

Work with ORM entities and database operations:

# ORM Entity
coldbox create orm-entity User table=users

# ORM Service
coldbox create orm-service UserService entity=User

# Virtual Entity Service
coldbox create orm-virtual-service UserService

# ORM Event Handler
coldbox create orm-event-handler

# CRUD operations
coldbox create orm-crud User

๐Ÿ”— Interceptors

Create AOP interceptors:

# Basic interceptor
coldbox create interceptor Security

# Interceptor with specific interception points
coldbox create interceptor Logger points=preProcess,postProcess

# With tests
coldbox create interceptor Security --tests

๐Ÿ”„ Development Workflow

Manage your development environment:

# Reinitialize ColdBox framework
coldbox reinit

# Auto-reinit on file changes
coldbox watch-reinit

# Open documentation
coldbox docs
coldbox docs search="event handlers"

# Open API documentation
coldbox apidocs

๐ŸŽ›๏ธ Global Options

Most commands support these common options:

  • --force - Overwrite existing files
  • --open - Open generated files in your default editor
  • --boxlang - Generate BoxLang code instead of CFML
  • --help - Show detailed help for any command

๐Ÿ’ก BoxLang Support

The CLI automatically detects BoxLang projects and generates appropriate code. You can also force BoxLang mode:

# Force BoxLang generation
coldbox create handler users --boxlang

# BoxLang project detection based on:
# - Server engine (BoxLang)
# - package.json testbox.runner setting
# - package.json language property

๐Ÿ“– Getting Help

Every command provides detailed help:

# General help
coldbox help

# Specific command help
coldbox create handler --help
coldbox create model --help

Credits & Contributions

I THANK GOD FOR HIS WISDOM IN THIS PROJECT

The Daily Bread

"I am the way, and the truth, and the life; no one comes to the Father, but by me (JESUS)" Jn 14:1-12

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.


Unreleased

7.8.0 - 2025-08-06

Added

  • Copilot instructions for AI coding assistance
  • If the skeleton is default and this is a BoxLang project, it will switch the skeleton to BoxLang.
  • added dependabot
  • Moved testbox-cli and commandbox-migrations to dependencies so we can use them in the CLI commands

7.7.0 - 2025-04-29

Fixed

  • More fixes for boxlang arguments

7.6.0 - 2025-04-28

Added

  • New modern template for creating modern apps with the latest features
  • New boxlang template for creating apps with the latest boxlang features
  • Modernization of all templates to use the latest features of ColdBox
  • New --boxlang argument to create content for BoxLang
  • New language argument detection for BoxLang

Changed

  • Updated to the latest Ubuntu images for the GitHub actions

Fixed

  • Fixed resource handler creation.

7.5.0 - 2024-10-16

Fixed

  • watch reinit issues with coldbox watch command
  • key [TEMPLATEPATH] doesn't exist when doing orm operations. This was a typo, it should have been templatesPath

7.4.0 - 2024-03-20

Fixed

  • Create resources missing open param

Added

  • More documentation

7.3.0 - 2024-02-12

Added

  • New github actions
  • Lazy load testbox-cli, commandbox-migrations only when used.

7.2.1 - 2023-05-19

Fixed

  • Fixed coldbox create layout failing due to unescpaed #view()# command

7.2.0 - 2023-05-18

Added

  • New version of CommandBox Migrations
  • Added testbox-cli as a dependency

7.1.0 - 2023-05-18

Added

  • BaseCommand hierarchy for all commands to inherit from
  • New print functions for uniformity of info, warning, success and error messages
  • New coldbox create service command to create services easily
  • Create model with migration now actually generates the property migrations
  • Create coldbox create model --service to create a model with a service
  • Create coldbox create model --all to create a model with a service and all the things

Fixed

  • Version should match major ColdBox version, moved to 7
  • Fixed coldbox create app command to finalize the create app job
  • Set default location to forgeboxStorage for new apps, this was missing
  • coldbox create handler was not creating the views
  • Models isLoaded() was actually wrong
  • Handler test specs carriage returns
  • When creating models with rest or resources, the handler was not being created

1.0.0 - 2023-05-03

Added

  • Migration from CommandBox core to a separate module
  • Updated all templates to ColdBox 7
  • Updated all resources to ColdBox 7 standard code
  • Add --force command to several commands for overwriting files
  • Create app new argument: migrations to init the migrations on the project: coldbox create app name="myApp" --migrations
  • create view command now has an open attribute to open the created views in the editor
  • You can create layouts with content now: create layout name="myLayout" content="my content"
  • You can create views with content now: create view name="myView" content="my content"
  • You can create resourceful handlers: create handler name="myHandler" --resource
  • You can create resourceful rest handlers: create handler name="myHandler" --resource --rest
  • You can create models with migrations now: create model name="myModel" --migration
  • You can create models with seeders now: create model name="myModel" --seeder
  • You can create models with handlers (normal or rest) now: create model name="myModel" --handler or create model name="myModel" --handler --rest
  • You can create models with a resource handler now: create model name="myModel" --resource
  • You can create models will all the things now: create model name="myModel" --all
  • New coldbox docs command to open the ColdBox docs in your browser and search as well: coldbox docs search="event handlers"
  • New coldbox apidocs command to open the ColdBox API Docs in your browser.

Fixed

  • Was resetting the scripts in the templates, which is not needed

Removed

  • Eclipse support

$ box install coldbox-cli

No collaborators yet.
     
  • {{ getFullDate("2023-04-11T19:37:23Z") }}
  • {{ getFullDate("2025-08-06T10:49:59Z") }}
  • 3,345
  • 7,717