CLI Lifecycle
onCLIStart
Announced when shell first starts, but before any commands are run or output has been flushed to the console.
interceptData
shellType
- The stringinteractive
if starting the interactive shell, orcommand
if running a one-off command and exitingargs
- An array of arguments provided from the OS whenbox
was executed.banner
- A string containing the CommandBox banner text that displays when in interactive mode.
This fires every time the reload
command runs and a fresh shell is created.
onCLIExit
Announced right before the shell exits and control is returned back to the OS. This fires every time the reload
command runs right before the shell is destroyed and re-created.
onSystemSettingExpansion
Announced every time a system setting in the format of ${something}
is expanded. Any interceptor listening can provide an expanded value.
interceptData
setting - The name of the setting with the default value removed.
defaultValue - The text after the final
:
or an empty string if there is no default providedresolved - Set this to
true
if your interceptor expands the value and returntrue
from your interceptor method so CommandBox stops the interceptor chain.context - A struct of values if this system setting is being expanded in the context of a JSON file.
onConfigSettingSave
Announced every time a Config Setting is added, removed, or updated.
interceptData
configFilePath- Full path to the
CommandBox.json
fileconfigSettings- Struct of current config settings
onEndpointLogin
Announced any time a user either logs into ForgeBox (forgebox login
) or switches users (forgebox use
)
interceptData
endpointName - Name of endpoint logged into
username - Username that was logged into
endpoint - Endpoint CFC instance
APIToken - API Token of user that logged in