菜单
Use this skill when configuring a ColdBox application in ColdBox.cfc, setting up environments, managing module settings, defining datasources, configuring logging with LogBox, setting up caching with CacheBox, or wiring dependencies with WireBox settings.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Use this skill when building WebSocket features with SocketBox in ColdBox/CFML/BoxLang. Covers the real SocketBox APIs for core WebSocket handling and STOMP broker usage, including correct base classes, method signatures, server-side sends, and client examples.
Use this skill when working with CacheBox as a standalone caching framework (outside ColdBox) -- installing, creating and bootstrapping the CacheFactory, configuring the DSL, choosing object stores and eviction policies, selecting cache providers (CacheBoxProvider, CF, Lucee), implementing cache-aside/stampede-protection patterns, registering standalone listeners, named caches, disk/JDBC stores, reaping, shutdown, or monitoring cache performance.
Use this skill when integrating AI capabilities into a ColdBox application using the BoxLang AI library (bx-ai module) -- including simple chat, streaming, pipelines, agents, RAG with vector memory, document loading, tool calling, and injecting the AI service into handlers or models.
Use this skill when choosing a ColdBox application layout (flat, boxlang, or modern), scaffolding a new ColdBox project, understanding project directory structure, deciding between app structure options, or migrating from one layout to another. Use when asked about flat layout, boxlang template, modern template, app structure, project skeleton, or web root separation.
Use this skill when building async pipelines, working with ColdBox Futures, running parallel computations with all()/allApply()/anyOf(), registering and managing thread-pool executors, or accessing the AsyncManager via the async() helper.
Use this skill when implementing caching inside a ColdBox application -- configuring CacheBox via ColdBox.cfc or config/CacheBox.cfc, injecting caches with WireBox (cachebox:name), using getCache() in handlers, event/view output caching with setEventCacheableEntry(), view fragment caching with renderView(cache=true), query caching, cache listeners as ColdBox interceptors, Redis/distributed provider setup, or choosing between default and template caches.
| name | coldbox-configuration |
| description | Use this skill when configuring a ColdBox application in ColdBox.cfc, setting up environments, managing module settings, defining datasources, configuring logging with LogBox, setting up caching with CacheBox, or wiring dependencies with WireBox settings. |
| applyTo | **/*.{bx,bxm,cfc,cfm,cfml} |
Use this skill when configuring a ColdBox application via config/ColdBox.cfc — the master application configuration file.
Examples use BoxLang (.bx) syntax by default. Adapt for your target language:
| Concept | BoxLang (.bx) | CFML (.cfc) |
|---|---|---|
| Class declaration | class [extends="..."] { | component [extends="..."] { |
| DI annotation | @inject above property name="svc"; | property name="svc" inject="svc"; |
| View templates | .bxm suffix | .cfm / .cfml suffix |
| Tag prefix | <bx:if>, <bx:output>, <bx:set> | <cfif>, <cfoutput>, <cfset> |
CFML Compat Mode: With BoxLang + CFML Compat module,
.bxand.cfcfiles coexist freely. BoxLang-native classes useclass {}(.bxfiles); CFML-compat classes usecomponent {}(.cfcfiles).
ColdBox.cfc contains sections for:
coldbox — core framework settingsenvironments — environment-specific overridesmodules — module settings per moduleinterceptors — registered interceptorslogbox — LogBox logging configurationcachebox — CacheBox cache configurationwirebox — WireBox DI configurationclass ColdBox extends coldbox.system.Coldbox {
function configure() {
// =============================================
// COLDBOX SETTINGS
// =============================================
coldbox = {
// Application name
appName : "My ColdBox Application",
appMapping : "root",
// Application reloading
reinitPassword : getSystemSetting( "REINIT_PASSWORD", "supersecret" ),
reinitKey : "reinit",
// Default handler and view
defaultHandler : "main",
defaultAction : "index",
defaultLayout : "Main",
defaultView : "main/index",
// Request Defaults
requestContextDecorator : "",
controllerDecorator : "",
// Custom interception points
customInterceptionPoints : [
"onUserLogin",
"onUserLogout",
"onOrderPlaced"
],
// Exception handler
exceptionHandler : "main.onException",
// Invalid event handler
invalidEventHandler : "main.onInvalidEvent",
// Request timeout
requestTimeout : 60,
// ColdBox settings
handlersIndexAutoReload : true, // Development only
modulesExternalLocation : [ "modules" ]
}
// =============================================
// ENVIRONMENT DETECTION
// =============================================
environments = {
development : "localhost,127.0.0.1,^local",
staging : "staging.example.com",
production : "example.com"
}
// =============================================
// LAYOUTS
// =============================================
layoutSettings = {
defaultLayout : "Main",
defaultView : "main/index"
}
// =============================================
// MODULES
// =============================================
moduleSettings = {
// CBSecurity settings
cbsecurity : {
userService : "UserService",
jwtSettings : {
secretKey : getSystemSetting( "JWT_SECRET", generateSecretKey( "AES", 256 ) ),
expiration : 60
}
},
// CBAuth settings
cbauth : {
userServiceClass : "UserService"
},
// CBI18N settings
cbi18n : {
defaultLocale : "en_US",
resourceBundles : {
main : "#appMapping#/includes/i18n/main"
}
}
}
// =============================================
// INTERCEPTORS
// =============================================
interceptors = [
{
class : "#appMapping#.interceptors.AppInterceptor",
name : "AppInterceptor"
}
]
// =============================================
// LOGBOX
// =============================================
logbox = {
// Appenders
appenders : {
// Console appender (development)
console : {
class : "coldbox.system.logging.appenders.ConsoleAppender",
levelMin : "DEBUG",
levelMax : "FATAL"
},
// Rolling file appender
rolling : {
class : "coldbox.system.logging.appenders.RollingFileAppender",
levelMin : "WARN",
levelMax : "FATAL",
properties : {
filePath : "#getDirectoryFromPath( getBaseTemplatePath() )#logs",
fileName : "app",
fileMaxSize : 5000,
fileMaxArchives : 2
}
}
},
// Root logger
root : { levelMin : "WARN", levelMax : "FATAL", appenders : "rolling" },
// Category loggers
categories : {
// App debug
"root" : { levelMin : "INFO", levelMax : "DEBUG", appenders : "console" }
}
}
// =============================================
// CACHEBOX
// =============================================
cachebox = {
// Configuration file
configFile : "#appMapping#.config.CacheBox"
}
// =============================================
// WIREBOX
// =============================================
wirebox = {
enabled : true,
singletonReload : true,
binder : "#appMapping#.config.WireBox"
}
}
// =============================================
// ENVIRONMENT-SPECIFIC OVERRIDES
// =============================================
function development() {
coldbox.handlersIndexAutoReload = true
coldbox.reinitPassword = ""
coldbox.customErrorTemplate = "/coldbox/system/exceptions/debugPanel.cfm"
}
function staging() {
coldbox.customErrorTemplate = "/coldbox/system/exceptions/customError.cfm"
}
function production() {
coldbox.handlersIndexAutoReload = false
coldbox.reinitPassword = getSystemSetting( "REINIT_PASSWORD", "changeme" )
coldbox.customErrorTemplate = "/coldbox/system/exceptions/customError.cfm"
}
}
CFML (.cfc):
component extends="coldbox.system.Coldbox" {
function configure() {
// =============================================
// COLDBOX SETTINGS
// =============================================
coldbox = {
// Application name
appName : "My ColdBox Application",
appMapping : "root",
// Application reloading
reinitPassword : getSystemSetting( "REINIT_PASSWORD", "supersecret" ),
reinitKey : "reinit",
// Default handler and view
defaultHandler : "main",
defaultAction : "index",
defaultLayout : "Main",
defaultView : "main/index",
// Request Defaults
requestContextDecorator : "",
controllerDecorator : "",
// Custom interception points
customInterceptionPoints : [
"onUserLogin",
"onUserLogout",
"onOrderPlaced"
],
// Exception handler
exceptionHandler : "main.onException",
// Invalid event handler
invalidEventHandler : "main.onInvalidEvent",
// Request timeout
requestTimeout : 60,
// ColdBox settings
handlersIndexAutoReload : true, // Development only
modulesExternalLocation : [ "modules" ]
}
// =============================================
// ENVIRONMENT DETECTION
// =============================================
environments = {
development : "localhost,127.0.0.1,^local",
staging : "staging.example.com",
production : "example.com"
}
// =============================================
// LAYOUTS
// =============================================
layoutSettings = {
defaultLayout : "Main",
defaultView : "main/index"
}
// =============================================
// MODULES
// =============================================
moduleSettings = {
// CBSecurity settings
cbsecurity : {
userService : "UserService",
jwtSettings : {
secretKey : getSystemSetting( "JWT_SECRET", generateSecretKey( "AES", 256 ) ),
expiration : 60
}
},
// CBAuth settings
cbauth : {
userServiceClass : "UserService"
},
// CBI18N settings
cbi18n : {
defaultLocale : "en_US",
resourceBundles : {
main : "#appMapping#/includes/i18n/main"
}
}
}
// =============================================
// INTERCEPTORS
// =============================================
interceptors = [
{
class : "#appMapping#.interceptors.AppInterceptor",
name : "AppInterceptor"
}
]
// =============================================
// LOGBOX
// =============================================
logbox = {
// Appenders
appenders : {
// Console appender (development)
console : {
class : "coldbox.system.logging.appenders.ConsoleAppender",
levelMin : "DEBUG",
levelMax : "FATAL"
},
// Rolling file appender
rolling : {
class : "coldbox.system.logging.appenders.RollingFileAppender",
levelMin : "WARN",
levelMax : "FATAL",
properties : {
filePath : "#getDirectoryFromPath( getBaseTemplatePath() )#logs",
fileName : "app",
fileMaxSize : 5000,
fileMaxArchives : 2
}
}
},
// Root logger
root : { levelMin : "WARN", levelMax : "FATAL", appenders : "rolling" },
// Category loggers
categories : {
// App debug
"root" : { levelMin : "INFO", levelMax : "DEBUG", appenders : "console" }
}
}
// =============================================
// CACHEBOX
// =============================================
cachebox = {
// Configuration file
configFile : "#appMapping#.config.CacheBox"
}
// =============================================
// WIREBOX
// =============================================
wirebox = {
enabled : true,
singletonReload : true,
binder : "#appMapping#.config.WireBox"
}
}
// =============================================
// ENVIRONMENT-SPECIFIC OVERRIDES
// =============================================
function development() {
coldbox.handlersIndexAutoReload = true
coldbox.reinitPassword = ""
coldbox.customErrorTemplate = "/coldbox/system/exceptions/debugPanel.cfm"
}
function staging() {
coldbox.customErrorTemplate = "/coldbox/system/exceptions/customError.cfm"
}
function production() {
coldbox.handlersIndexAutoReload = false
coldbox.reinitPassword = getSystemSetting( "REINIT_PASSWORD", "changeme" )
coldbox.customErrorTemplate = "/coldbox/system/exceptions/customError.cfm"
}
}
// Using CFML/BoxLang environment variable helper
function configure() {
vars.datasource = getSystemSetting( "DB_DSN", "myapp" )
coldbox = {
appName : getSystemSetting( "APP_NAME", "My App" ),
reinitPassword : getSystemSetting( "REINIT_PASSWORD", "" )
}
}
// Override any module setting from ColdBox.cfc
moduleSettings = {
// Override cbsecurity module settings
cbsecurity : {
firewall : {
rules : [
{
secureList : "admin",
roles : "admin",
match : "url"
}
]
}
},
// Override cborm module settings
cborm : {
eventHandling : true,
autoEvict : true
},
// Override your own module settings
myModule : {
apiKey : getSystemSetting( "MY_MODULE_API_KEY", "" ),
timeout : 30
}
}
getSystemSetting() for all secrets/credentials — never hard-code themdevelopment(), staging(), production()) for per-environment settingsenvironments regex patterns for automatic environment detection by hostnamehandlersIndexAutoReload = true in development for instant handler discoverymoduleSettings to override module defaults instead of editing module codelogbox appenders per environment (verbose in dev, file-only in production)