Please wait

Loading...

Start typing in the pseudo command bar to explore the commands available.

help

Display help for a command

The <info>help</info> command displays help for a given command:

  <info>./bin/acli help list</info>

You can also output the help in other formats by using the <comment>--format</comment> option:

  <info>./bin/acli help --format=xml list</info>

To display the list of available commands, please use the <info>list</info> command.

Usage

acli help [--format FORMAT] [--raw] [--] [<command_name>]

Arguments

  • command_name

    Optional

    The command name

    Defaults to "help"

Options

  • --format

    Required

    The output format (txt, xml, json, or md)

    Defaults to "txt"

  • --raw

    Optional

    To output raw command help

    Defaults to false

  • --help | -h

    Optional

    Display help for the given command. When no command is given display help for the <info>list</info> command

    Defaults to false

  • --quiet | -q

    Optional

    Do not output any message

    Defaults to false

  • --verbose | -v|-vv|-vvv

    Optional

    Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

    Defaults to false

  • --version | -V

    Optional

    Display this application version

    Defaults to false

  • --ansi

    Optional

    Force (or disable --no-ansi) ANSI output

  • --no-ansi

    Optional

    Negate the "--ansi" option

    Defaults to false

  • --no-interaction | -n

    Optional

    Do not ask any interactive question

    Defaults to false