CommandBox : CLI, Package Manager, REPL & More
Search…
5.5.0
Introduction
About This Book
Authors
Overview
Release History
Getting Started Guide
Setup
Usage
IDE Integrations
Config Settings
Embedded Server
Package Management
Task Runners
Helpful Commands
Deploying CommandBox
TestBox Integration
Developing For CommandBox
Modules
Commands
Interceptors
Injection DSL
Example Project
FusionReactor for the CLI
ForgeBox Enterprise
Introduction
Storage
Commands
Usage
Powered By GitBook
Example Project

Example Project

Here is an example CommandBox module that uses an interceptor (in the ModuleConfig.cfc) and custom commands to help manage its settings.
On Forgebox:
On GitHub:

CommandBox Banner Customizer

Ever gotten tired of the same lame ASCII art every time you start the CommandBox shell in interactive mode? Well fear not, this module is for you!

Installation

Install the module like so:
1
CommandBox> install commandbox-banner-customizer
Copied!
Once you've done that, there are three module settings you can override to affect how the CLI starts up.

Hide the banner

1
CommandBox> banner off
Copied!
Now reload the CLI and the ASCII art is gone.

Show the banner

1
CommandBox> banner on
Copied!
Now reload the CLI and the ASCII art is back.

Custom banner text

1
CommandBox> banner text "I like spam!"
Copied!
Now reload the CLI and your custom message will appear to greet you. Note this setting is ignored if the banner is off.

Custom banner file

Want to get all kinds of funky and create your own ASCII art of your cat? Save the exact text you want to output (can be multiple lines) into a file and specify the file path here:
1
CommandBox> banner file myCustomBanner.txt
Copied!
Note this setting is ignored if the banner is off or if banner text is set. For extra credit, try including ANSI escape codes in your text file for a color-coded banner

Advanced

All these example commands do is set config settings for you. You can also control the module settings without the banner commands by directly setting the config settings like so:
1
CommandBox> config set modules.commandbox-banner-customizer.hidebanner=true
2
CommandBox> config set modules.commandbox-banner-customizer.bannertext="I like spam!"
3
CommandBox> config set modules.commandbox-banner-customizer.bannerfilepath="C:\\myCustomBanner.txt"
Copied!
You can see the current state of this modules settings at any time by using config show to print it out.
1
CommandBox> config show modules.commandbox-banner-customizer
Copied!
Previous
Injection DSL
Next
FusionReactor for the CLI
Last modified 1mo ago
Copy link
Edit on GitHub
Contents
Example Project
CommandBox Banner Customizer
Installation
Advanced