ColdBox CLI

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 matches the major version of ColdBox. Current version: 8

• If you are using ColdBox 8, use CLI @8 (recommended)
• If you are using ColdBox 7, use CLI @7.8.0 (recommended)
• If you are using ColdBox 6, use CLI @6 (legacy support)

This versioning ensures you get the correct commands and features for your version of ColdBox.

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. BoxLang is now the default language for new applications:

# Create a basic ColdBox app (BoxLang by default)
coldbox create app myApp
coldbox create app myApp --boxlang   # Force BoxLang (default)

# Create a CFML app explicitly
coldbox create app myApp --cfml

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

# Create with additional features
coldbox create app myApp --migrations     # Database migrations support
coldbox create app myApp --docker         # Docker environment setup
coldbox create app myApp --vite          # Vite frontend asset building
coldbox create app myApp --rest          # REST API configuration

# Combine multiple features
coldbox create app myApp --migrations --docker --vite

# Interactive app wizard (recommended for beginners)
coldbox create app-wizard

🧙‍♂️ Interactive App Wizard

The app-wizard command provides an interactive, step-by-step process for creating new applications. It's perfect for beginners or when you want to explore all available options:

coldbox create app-wizard

The wizard will guide you through:

1. Project Location: Whether to create in current directory or a new folder
2. Language Selection: Choose between BoxLang (default) or CFML
3. Project Type: API/REST service or full web application
4. Frontend Setup: Optional Vite integration for web applications
5. Environment: Optional Docker containerization
6. Database: Optional migrations support

Example Wizard Flow:

Are you currently inside the "myapp" folder? [y/n]: n
Is this a BoxLang project? [y/n]: y
Are you creating an API? [y/n]: n
Would you like to configure Vite as your Front End UI pipeline? [y/n]: y
Would you like to setup a Docker environment? [y/n]: y
Are you going to require Database Migrations? [y/n]: y

Application Templates

The CLI supports multiple application templates (skeletons), or you can use your own via any FORGEBOX ID, GitHub repo, local path, zip or URL. BoxLang templates are now the primary focus for modern development:

🥊 BoxLang Templates (Recommended)

• boxlang (default) - A modern ColdBox app using BoxLang as the primary language with latest features
• modern - A modern ColdBox app supporting both BoxLang and CFML with contemporary architecture
• rest - A ColdBox REST API template optimized for BoxLang development

📜 Legacy CFML Templates

• flat - A classic ColdBox app with a flat structure for traditional CFML development
• rest-hmvc - A RESTful ColdBox app using HMVC architecture
• supersimple - A bare-bones template for minimal setups
• vite - A ColdBox app integrated with Vite for frontend development (legacy)

🚀 Template Features

Modern templates (boxlang, modern) support additional features via flags:

• --vite - Integrates Vite for modern frontend asset building and hot reloading
• --rest - Configures the application as a REST API service
• --docker - Includes Docker configuration for containerized development
• --migrations - Sets up database migrations support

⚡ Vite Integration

The CLI now supports Vite integration for modern frontend development with hot module replacement and optimized builds:

# Create app with Vite support
coldbox create app myApp --vite

# Available for BoxLang and Modern templates
coldbox create app myApp skeleton=modern --vite

Vite Features Included:

• Pre-configured vite.config.mjs with ColdBox/BoxLang integration
• Hot module replacement (HMR) for development
• Optimized production builds with code splitting
• Asset preprocessing for CSS, SCSS, JavaScript, and TypeScript
• Development server with proxy configuration
• Build scripts in package.json

Development Workflow:

# Start development server with hot reloading
npm run dev

# Build for production
npm run build

# Preview production build
npm run preview

🐳 Docker Integration

The CLI provides Docker integration to containerize your ColdBox applications for consistent development and deployment environments:

# Create app with Docker support
coldbox create app myApp --docker

# Combine with other features
coldbox create app myApp --docker --vite --migrations

Docker Features Included:

• Multi-stage Dockerfile optimized for ColdBox applications
• docker-compose.yml for local development with services
• Database service configuration (PostgreSQL/MySQL)
• Redis caching service setup
• Environment variable configuration
• Production-ready container optimization
• Health checks and monitoring setup

Docker Commands:

# Build and start development environment
docker-compose up -d

# View logs
docker-compose logs -f

# Stop services
docker-compose down

# Rebuild containers
docker-compose up --build

🎯 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 without prompting
• --open - Open generated files in your default editor
• --boxlang - Force BoxLang code generation (usually not needed as it's the default)
• --cfml - Force CFML code generation (overrides BoxLang default)
• --help - Show detailed help for any command

Application-Specific Flags

For application creation commands:

• --migrations - Include database migrations support
• --docker - Include Docker configuration and containerization
• --vite - Include Vite frontend asset building (modern/BoxLang templates)
• --rest - Configure as REST API application (BoxLang templates)

Language Generation Control

The CLI supports both automatic detection and manual override of the target language. BoxLang is now the default language for all new applications and generated code:

• Default: BoxLang code generation for new applications and components
• Automatic: Uses detection methods (server engine, box.json settings) for existing projects
• Force CFML: Use --cfml flag to generate CFML code regardless of detection
• Force BoxLang: Use --boxlang flag to explicitly generate BoxLang code (usually not needed as it's the default)

💡 BoxLang Support

The CLI automatically detects BoxLang projects and generates appropriate code. You can also force BoxLang mode using the --boxlang flag.

🔍 Automatic Detection

The CLI detects BoxLang projects using three methods (in order of precedence):

1. Server Engine Detection: Running on a BoxLang server
2. TestBox Runner Setting: When testbox.runner is set to "boxlang" in box.json
3. Language Property: When language is set to "boxlang" in box.json

⚙️ Configuration Examples

Method 1: Language Property (Recommended)

{
    "name": "My BoxLang App",
    "language": "boxlang",
    "testbox": {
        "runner": "/tests/runner.bxm"
    }
}

Method 2: TestBox Runner Setting

{
    "name": "My App",
    "testbox": {
        "runner": "boxlang"
    }
}

🚀 Usage Examples

# Default behavior (creates BoxLang code)
coldbox create handler users
coldbox create model User

# Explicit BoxLang generation (usually not needed)
coldbox create handler users --boxlang

# Force CFML generation for legacy projects
coldbox create handler users --cfml
coldbox create app myApp --cfml

📝 Generated Code Differences

When BoxLang mode is detected or forced:

• Uses .bx file extensions instead of .cfc
• Generates class syntax instead of component
• Uses BoxLang-specific template variants
• Creates BoxLang test files (.bxm extensions)

🤖 AI Coding Assistance

The CLI now includes Copilot instructions to enhance AI-powered development workflows. These instructions help AI assistants understand ColdBox project structure and generate appropriate code:

Features

• Intelligent Code Generation: AI assistants can better understand ColdBox conventions and patterns
• Template-Aware Suggestions: Context-aware code suggestions based on your project type
• BoxLang & CFML Support: Appropriate suggestions for both language targets
• Framework Integration: Deep understanding of ColdBox architecture and best practices

Copilot Instructions

The CLI includes specialized instruction sets:

• Modern Apps: Instructions optimized for contemporary ColdBox applications
• Legacy Projects: Support for traditional flat-structure applications
• BoxLang Focus: Enhanced support for BoxLang-specific patterns
• Framework Patterns: MVC, HMVC, and REST API architectural guidance

These instructions are automatically included in modern application templates to provide the best AI coding experience out of the box.

📖 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