菜单
Use this skill when understanding ContentBox architecture, core modules, service layer, multi-site behavior, security foundations, and the recommended extension points for building or maintaining ContentBox solutions.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | contentbox-boxlang-overview |
| description | Use this skill when understanding ContentBox architecture, core modules, service layer, multi-site behavior, security foundations, and the recommended extension points for building or maintaining ContentBox solutions. |
| applyTo | **/*.{bx,bxm,cfc,cfm,cfml} |
ContentBox is a professional open-source hybrid modular CMS (Content Management System) built on ColdBox. It supports both traditional CMS and headless architectures, running on CFML engines (Lucee, Adobe ColdFusion) and BoxLang.
ContentBox follows a layered modular architecture:
/ (Root App) ← Host ColdBox application, local dev shell
├── modules/contentbox/ ← Core ContentBox engine
│ ├── ModuleConfig.cfc ← Core module configuration
│ ├── models/ ← Domain entities and services
│ ├── widgets/ ← Core widgets (19 built-in)
│ ├── themes/default/ ← Default theme
│ ├── migrations/ ← Database migrations
│ └── modules/ ← Sub-modules
│ ├── contentbox-admin/ ← Admin interface (entry: cbadmin)
│ ├── contentbox-api/ ← REST API (v1)
│ ├── contentbox-ui/ ← Public-facing UI
│ └── contentbox-deps/ ← Dependencies (cborm, etc.)
├── modules_app/contentbox-custom/ ← Customization layer
│ ├── _themes/ ← Custom user themes
│ ├── _widgets/ ← Custom user widgets
│ ├── _modules/ ← Custom user modules
│ └── _content/ ← Custom content
└── modules/ ← Standalone ColdBox modules
ContentBox is both a traditional CMS and a headless CMS:
Everything in ContentBox is a module:
modules/contentbox/modules_app/contentbox-custom/modules/this.ormEnabled = true in Application.cfcBaseEntity with UUID primary keysisDeleted flag| Service | DSL | Purpose |
|---|---|---|
entryService | entryService@contentbox | Blog entry CRUD |
pageService | pageService@contentbox | Page CRUD |
contentService | contentService@contentbox | Unified content service |
authorService | authorService@contentbox | Author management |
categoryService | categoryService@contentbox | Category CRUD |
menuService | menuService@contentbox | Menu management |
settingService | settingService@contentbox | Settings management |
securityService | securityService@contentbox | Authentication/authorization |
widgetService | widgetService@contentbox | Widget registry |
themeService | themeService@contentbox | Theme management |
siteService | siteService@contentbox | Multi-site management |
mediaService | mediaService@contentbox | Media management |
contentStoreService | contentStoreService@contentbox | Key-value content |
twoFactorService | twoFactorService@contentbox | 2FA management |
cb | CBHelper@contentbox | CBHelper for theme/UI |
The CBHelper@contentbox is the primary API for theme and UI development:
property name="cb" inject="CBHelper@contentbox"
// Site
cb.site() // Current site entity
cb.siteURL() // Site base URL
cb.siteName() // Site name
// Content
cb.getContent() // Current content (entry/page)
cb.entryURL( entry )
cb.pageURL( page )
cb.categoryURL( category )
// Theme
cb.getThemeSetting( "name" )
// Widgets
cb.widget( "WidgetName", { args } )
// Rendering
cb.renderCollection( template, collection )
cb.renderView( view )
// Menus
cb.menu( "main" )
// Media
cb.mediaURL( media )
cb.mediaURL( media, "thumbnail" )
// RSS
cb.rssURL()
cb.rssCommentsURL()
// Search
cb.searchURL()
cb.searchURL( "query" )
// Subscriptions
cb.subscribeURL()
cb.unsubscribeURL()
| Point | When |
|---|---|
cb_onContentRendering | Before content is rendered |
cb_onContentStoreRendering | Before ContentStore content is rendered |
Layout injection, content editor, content lifecycle, author management, dashboard, settings, and more. See the admin extension skill for the full list.
| Type | Description |
|---|---|
| Entries | Blog posts with dates, categories, comments |
| Pages | Static pages with hierarchical structure |
| ContentStore | Key-value content blocks |
Widgets extend BaseWidget and implement renderIt(). They are discovered from:
_widgets/)Themes define the visual presentation. Required files:
Theme.bx — metadata, settings, lifecycle callbackslayouts/blog.bx, layouts/pages.bx — mandatory layoutsviews/index.bx, entry.bx, page.bx, archives.bx, error.bx — mandatory viewsREST API v1 at /api/v1/ with JWT authentication:
# Start local server
box server start
# Migrations
box run-script contentbox:migrate:create name=YourMigration
box run-script contentbox:migrate
box run-script contentbox:migrate:up
box run-script contentbox:migrate:down
box run-script contentbox:migrate:fresh
# Format code
box run-script format
box run-script format:check
# Frontend builds
npm run dev
npm run watch
npm run prod
npm run build-dev
npm run build-prod
http://127.0.0.1:8589/tests/runner.cfmhttp://127.0.0.1:8589/tests/runner-api.cfmtests/resources/BaseTest.cfc, tests/resources/BaseApiTest.cfcContentBox supports three engines:
Server configs: server-lucee@*.json, server-adobe@*.json, server-boxlang@*.json
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.