The description of the CLI command (default this.name)
An example of how to run this CLI command
Should the server initialize before running this command?
The inputs of the CLI command (default: {})
The name of the CLI command.
Should the server start before running this command?
An optional method to append additional information to the --help response for this CLI command
The main "do something" method for this CLI command. It is an async
method.
If error is thrown in this method, it will be logged to STDERR, and the process will terminate with a non-0 exit code.
Generated using TypeDoc
An Actionhero CLI Command. For inputs, you can provide Options (--thing=stuff) with the "Inputs" object, or define Arguments in the name of the command (
greet [name]
)