菜单
Use this skill for installing, configuring, and upgrading CommandBox CLI: Homebrew install on Mac, apt-get on Linux, Windows install, Java requirements, custom home directory, upgrading CommandBox, light/thin binaries, non-Oracle JRE setup, and first-run configuration.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Use this skill when writing JavaDoc-style DocBox comments on BoxLang or CFML classes, properties, functions, and arguments; adding @author/@version/@since/@return/@throws/@deprecated block tags; using @doc.type for generic array/struct types; or preparing source code for API documentation generation with DocBox.
Use this skill when configuring DocBox to generate API documentation, choosing output strategies (HTML, JSON, UML, CommandBox), setting up single or multiple source directories, running DocBox from BoxLang CLI or CommandBox CLI, customizing HTML themes, excluding files/folders from output, or building custom output strategies.
Use this skill when setting up code coverage analysis for ColdBox/ColdFusion/BoxLang applications, configuring coverage reporting, integrating coverage with CI pipelines, using TestBox coverage options, interpreting coverage metrics, or improving test coverage of untested code paths.
Use this skill when creating test fixtures, factory patterns, or test data builders in ColdBox/TestBox, setting up shared fixture files, creating user/model factories with overrides, using cbMockData for realistic fake data generation, or managing test data setup and teardown.
Use this skill when using the TestBox $assert object for xUnit-style assertions: isTrue, isEqual, includes, isEmpty, key, instanceOf, throws, between, closeTo, lengthOf, match, null, typeOf, and others; registering custom assertion functions with addAssertions(); or using BoxLang dynamic assertion methods (assertIsTrue, assertBetween, etc.).
Use this skill when writing BDD-style tests with TestBox using describe/it blocks, feature/story/scenario/given/when/then Gherkin-style suites, lifecycle hooks (beforeAll/afterAll/beforeEach/afterEach/aroundEach), focused specs (fit/fdescribe), skipping specs (xit/xdescribe/skip()), spec data binding, asyncAll parallel specs, nested suite trees, labels, or organizing tests around behavior descriptions.
| name | commandbox-setup |
| description | Use this skill for installing, configuring, and upgrading CommandBox CLI: Homebrew install on Mac, apt-get on Linux, Windows install, Java requirements, custom home directory, upgrading CommandBox, light/thin binaries, non-Oracle JRE setup, and first-run configuration. |
CommandBox is a standalone CLI tool for Windows, Mac, and Linux that provides a command line interface for CFML/BoxLang development, package management, embedded servers, and automation. Written in CFML on top of WireBox, Undertow, and Lucee.
~/.CommandBox/ (or customized via commandbox_home)# Stable release
brew install commandbox
# Bleeding edge
brew tap ortus-solutions/homebrew-boxtap
brew install --head ortus-solutions/homebrew-boxtap/commandbox
# Upgrade
brew upgrade commandbox
# Switch between versions
brew install commandbox@5.1.1
brew unlink commandbox
brew link commandbox@5.1.1
After install, run box to complete the one-time unpacking:
box
# Debian/Ubuntu setup (libappindicator for tray icon)
sudo apt install libappindicator3-dev # Ubuntu 18.04+
sudo apt install libappindicator-dev # Older Ubuntu/Debian
# Add Ortus repo and install
curl -fsSl https://downloads.ortussolutions.com/debs/gpg | sudo apt-key add -
echo "deb https://downloads.ortussolutions.com/debs/noarch /" | sudo tee /etc/apt/sources.list.d/commandbox.list
sudo apt-get update && sudo apt-get install commandbox
# RPM / yum
curl -fsSl https://downloads.ortussolutions.com/KEYS | sudo rpm --import -
echo -e "[commandbox]\nname=CommandBox\nbaseurl=https://downloads.ortussolutions.com/rpms/noarch\nenabled=1\ngpgcheck=1\ngpgkey=https://downloads.ortussolutions.com/KEYS" | sudo tee /etc/yum.repos.d/commandbox.repo
sudo yum install commandbox
box.exe from downloads.ortussolutions.combox.exe in a directory on your PATHbox.exe to complete first-time unpacking# Download the appropriate binary, unzip and place in PATH
# macOS/Linux: /usr/local/bin/box
# Run to unpack
box
By default, CommandBox unpacks into ~/.CommandBox. Override with:
Command-line flag:
box -commandbox_home=/custom/path
commandbox.properties file (place in same directory as the binary):
commandbox_home=/custom/path
# or relative path
commandbox_home=../boxHome
Note: On Homebrew installs, place
commandbox.propertiesin/opt/homebrew/Cellar/commandbox/<version>/libexec/bin/
CommandBox offers smaller binaries for environments where size matters:
| Binary | Description |
|---|---|
| Standard | Full install with all core modules |
| Light | No server or forgebox modules bundled |
| Thin | No modules bundled — all downloaded on first run |
# Light binary: download from releases page with "-light" suffix
# Thin binary: download with "-thin" suffix
CommandBox embeds its own JRE or uses the system JRE:
# Check what Java CommandBox is using
box java version
# List available JDKs
box java list
# Install a specific JDK
box java install openjdk21
# Set a custom JRE path (place 'jre' folder next to the box binary)
# Or set JAVA_HOME env var before running box
For non-Oracle JREs (e.g., OpenJDK, Azul Zulu):
# Set JAVA_HOME to point to your JDK
export JAVA_HOME=/path/to/openjdk21
box
# From within CommandBox shell
upgrade
# Or via Homebrew on macOS
brew upgrade commandbox
# Check current version
version
Warning: Homebrew upgrade erases the current Cellar folder. Back up
commandbox.propertiesbefore upgrading.
# Enter interactive shell
box
# Check version
version
# Update to latest
upgrade
# Set ForgeBox API key (for publishing packages)
config set endpoints.forgebox.APIToken=your-api-key
# Check version
box version
# Run a quick command
box echo "CommandBox is working!"
# List installed modules
box list --system