coldbox-docbox-generation

Generate API documentation from BoxLang and CFML source code.

1|Updated Apr 10, 2026
One-click install
npx skills add https://github.com/ColdBox/skills --skill coldbox-docbox-generation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: coldbox-docbox-generation
Source: https://github.com/ColdBox/skills/tree/main/docbox/docbox-generation
Command: npx skills add https://github.com/ColdBox/skills --skill coldbox-docbox-generation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill streamlines configuring and running DocBox to produce consistent, navigable API documentation for BoxLang and CFML codebases, removing uncertainty about strategies, mappings, excludes, themes, and CLI or build integrations.

Core Features & Use Cases

  • Flexible output strategies: Configure and run HTML, JSON, UML, CommandBox, or custom template strategies, and combine multiple strategies in a single run.
  • Source mapping and exclusions: Support single or multiple source directories with mapping entries and exclude patterns to omit tests, build artifacts, or dotfolders.
  • CLI and build integration: Execute DocBox from BoxLang CLI, CommandBox CLI, or integrate into ColdBox build tasks with configurable output directories and themes.
  • Use Case: Produce both user-facing HTML docs and machine-readable JSON indexes for a microservice repository while excluding test and generated code folders.

Quick Start

Generate API docs for the project at /app using mapping app and output the results to /docs.

Frequently Asked Questions about coldbox-docbox-generation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate API documentation for a CFML or BoxLang project?

You can generate API documentation for CFML or BoxLang by configuring DocBox with source directory mappings, selecting an output strategy like HTML or JSON, and executing the generation via CLI or build tasks to produce navigable docs.

Can I output both HTML and JSON API docs simultaneously from the same source code?

Yes, you can combine multiple output strategies in a single run. Configure DocBox to apply both HTML and JSON strategies simultaneously, producing user-facing documentation and machine-readable indexes from one execution.

How do I exclude test folders and build artifacts when generating API docs?

Exclude test folders and build artifacts during API doc generation by defining exclude regex patterns in your DocBox configuration. This omits specified directories, dotfolders, and generated code from the final navigable documentation output.

Does DocBox support generating UML diagrams from source code?

Yes, DocBox supports UML diagram generation as an output strategy. Select the UML strategy in your configuration to automatically extract structural relationships from BoxLang or CFML source code and render them as UML diagrams.

What is the best way to integrate API doc generation into a ColdBox build task?

The best way to integrate API doc generation into a ColdBox build task is to configure DocBox within your build script, define source mappings and output directories, and execute the documentation generation process automatically during the build lifecycle.

Can I register a custom strategy class for bespoke API documentation output?

Yes, you can register custom strategy classes for bespoke API documentation output. DocBox allows you to optionally register custom strategy classes to generate specialized documentation formats tailored to your specific project requirements.