boxlang-modules-and-packages

Install and configure BoxLang modules via CommandBox and JSON.

16|78|Updated Nov 28, 2014

Search Tags:#orm #modules #forgebox #module-management #boxlang #box-install #cfml-compatibility

Ready to run

npx skills add https://github.com/ortus-docs/coldbox-docs --skill boxlang-modules-and-packages

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: boxlang-modules-and-packages
Source: https://github.com/ortus-docs/coldbox-docs/tree/main/.agents/skills/boxlang-modules-and-packages
Command: npx skills add https://github.com/ortus-docs/coldbox-docs --skill boxlang-modules-and-packages

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps developers install, configure, and introspect BoxLang modules and packages, including core and BoxLang+ premium modules, CFML compatibility, ORM, and mail subsystems.

Core Features & Use Cases

Install and configure modules via the CommandBox box install workflow and manage module settings in boxlang.json or Application.bx.
Enable, disable, and introspect installed modules, including bx-redis, bx-pdf, bx-csv, bx-spreadsheet, bx-mail, and bx-orm, with sample configurations.
Use case: quickly provision a new project with needed modules and compatibility layers, then validate module visibility and behavior at runtime.

Quick Start

Run the box install command for a module (e.g., bx-redis) and enable it in boxlang.json.

Frequently Asked Questions about boxlang-modules-and-packages

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

FAQPage Schema

How do I install and configure BoxLang modules like bx-redis or bx-orm?▼

Install BoxLang modules using the CommandBox `box install` command, then enable and configure them by adding module settings to your boxlang.json or Application.bx file.

What is the best way to manage BoxLang module settings in a project?▼

Manage BoxLang module settings by defining configuration directly in boxlang.json or Application.bx, allowing you to easily enable, disable, and introspect installed modules at runtime.

Does this approach support CFML compatibility and premium BoxLang+ modules?▼

Yes, this module management workflow supports installing and configuring core BoxLang modules, BoxLang+ premium offerings, CFML compatibility layers, and specialized subsystems like ORM and mail.

How can I check if an installed BoxLang module is enabled and visible at runtime?▼

Use the provided introspection utilities to validate module visibility and behavior at runtime, ensuring your installed BoxLang modules are correctly enabled and functioning within your application.

Why do I need CommandBox to provision a new BoxLang project with modules?▼

CommandBox is required to run the `box install` workflow, which safely provisions your BoxLang project by downloading needed modules and applying validation and safe defaults during setup.