commandbox.system.modules_app.system-commands.commands

Class help

lucee.Component
    extended by commandbox.system.modules_app.system-commands.commands.help

Display CommandBox help. Call this command with no parameters to see general help for all commands. Help includes command aliases, paramters, and example syntax. . {code:bash} help {code} . Pass in a command or namespace to get help on that item. . {code:bash} help testbox help testbox run {code} . "help" can also be appended to the end of the command . {code:bash} testbox help testbox run help {code}

Class Attributes:
  • aliases : h,/?,?,--help,-help
    •  
  • synchronized : false
    •  
  • accessors : false
    •  
  • persistent : false
    •  
    Property Summary
    type property default serializable required
    any commandService


    • access = public
    • returntype = any
    • inject = CommandService
    		 true false
    Method Summary
    private any printCommandHelp(string command, any commandInfo)
         Outputs help information for a single command.
    any run([any command=''])
     
    Methods inherited from class lucee.Component
    None
    Property Detail

    commandService

    property any commandService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - CommandService
    serializable - true
    Method Detail

    printCommandHelp

    private any printCommandHelp(string command, any commandInfo)

    Outputs help information for a single command.

    Parameters:
    command - String command
    commandInfo - Reference to Command CFC

    run

    public any run([any command=''])

    Parameters:
    command - The command to get help for. If blank, displays help for all commands