Tab Completion

One of the most productive features of the shell is tab completion. This means you can type a partial command and hit the tab key on your keyboard to be prompted with suggestions that match what you've typed so far. If there is only one match, it will be finished for you. This can save a lot of typing and will be a familiar concept to those already living in a CLI environment.

When "tab" is pressed, the text you've entered so far is run through the CommandBox command parser to see if it can match a namespace, command, or parameters. If you press tab at an empty prompt, all top level commands and namespaces will display. Since tab completion is run through the standard command parser, that means it works on command aliases as well.


If your text matches only command, namespace, or alias, it will be auto-filled in for you. For instance, if you type the following and press tab...

CommandBox> cold

the coldbox namespace will be filled in and followed by a space so you are ready to continue typing.

CommandBox> coldbox

If you then press tab again, you will be presented with a list of second-level namespaces inside of coldbox and the same prompt will be output again below it so you can continue typing.

CommandBox> coldbox
war test-watch notes create reinit module compile help
stats test-directory interceptor test report integrate
CommandBox> coldbox


If the parser finds a complete command, it will move on to parameter completion which is slightly more complicated since at first, there is no way to tell if you are going to named parameters, positional parameters, and/or flag. Based on what parameters you've typed so far, if any, CommandBox will do it's best to give you only relevant options. If it is unsure, it will provide you with every possibility it can think of. Don't be afraid to try pressing tab while typing parameters, you may be surprised how often we can guess where you're going!

Here is CommandBox giving every option possible for the delete command. Note, force and recurse are booleans, so they can be specified as flags.

CommandBox> delete
path= force= --force recurse= --recurse


If you have started typing named parameters, CommandBox will only suggest unused named parameters and flags.

CommandBox> delete path=myDir force=true
 recurse= --recurse
CommandBox> delete path=myDir force=true

If you are using named parameters, and you have typed the name of a parameter followed by an equals sign and no space, CommandBox will attempt to prompt valid values. This includes but is not limited to booleans and file system paths.

Here, true and false are offered as possible values for the force parameter.

CommandBox> delete path=myDir force=
true false
CommandBox> delete path=myDir force=

Here, all files and folders in the current working directory are offered as possibilities for the path parameter of the delete command.

CommandBox> delete path=
.project Application.cfc box.json coldbox/ config/ favicon.ico handlers/ includes/
index.cfm interceptors/ layouts/ lib/ model/ modules/ remote/ robots.txt
tests/ views/
CommandBox> delete path=


Tab completion for positional parameters works the same as the "value" portion of named parameters. Parameter names will also show up when you hit tab even when using positional parameters. This is on purpose to remind you of what options you have, but you obviously won't type them.


Tab completion will always work for flags if your command has any boolean parameters. Here we type -- in the delete command and we are prompted with --force and --recurse.

CommandBox> delete myDir --
--force --recurse
CommandBox> delete myDir --


Commands have the ability to give hints in the form of a static list or a runtime function with dynamic output.

Here the forgebox show command dynamically provides completion for its type attribute based on the current types returned by the ForgeBox REST API.

CommandBox> forgebox show type=
caching cfbuilder-extensions cms commandbox-commands commandbox-recipes contentbox-layouts
contentbox-modules contentbox-widgets di interceptors logging models
modules mvc plugins projects testing wirebox-aspects
CommandBox> forgebox show type=

results matching ""

    No results matching ""