Command Reference¶
CmdBox is organized into six subcommands. Each handles a distinct area of functionality.
| Subcommand | Description |
|---|---|
cmd |
Add, edit, search, and delete saved commands. |
var |
Add, edit, search, and delete saved variables. |
tag |
Add, edit, search, and delete tags. |
run |
Execute saved commands by alias. |
history |
View and re-run past command executions. |
settings |
View and edit your CmdBox configuration. |
init |
Set up shell integration to enable running commands in your current terminal session. |
Running a Saved Command¶
The most common thing you will do in CmdBox is run a saved command. You do not need the run
subcommand for this — just use the alias directly:
The run subcommand is available when you need more control over how a command executes, such
as setting a working directory, passing environment variables, or previewing the resolved
command before running it:
See the run reference for the full list of options.
Getting Help¶
Every subcommand supports the --help flag, which displays its available options and usage
directly in the terminal: