yourCommand help, the text they see is the hint attribute on the component. The easiest way to add this is via a Javadoc-style comment at the top of your component. Feel free to include sample executions which can be wrapped in
run()method. This will also be visible in the help command as well as the Command API docs.
pathin their names will automatically give file system suggestions.
optionslist specified and they will all be used. The user will be presented with the combined list of tab completion candidates.
optionsattribute for that parameter that is a comma-delimited list of options for tab completion to give.
optionsUDFattribute for that parameters that points to a function name in the command CFC that will be called. This function needs to return an array of all possible values. CommandBox will do the work of filtering down partial matches if they're in the middle of typing.
install coldand hitting tab to see what happens.
namespace helpby creating a command CFC called
help.cfcin the root of that folder. The help command should print out whatever information you want. CommandBox will automatically call it when the users needs help for that namespace.