You are here: Supporting Documents > everRun Command Line Interface Reference > AVCLI Command Overview > Using AVCLI Help

Using AVCLI Help

This topic describes how to use AVCLI help.

Listing All Commands

To list all available AVCLI commands, type:

$ avcli help

The output follows:

[root@node0 zoneinfo]# avcli help
Usage: avcli [OPTION]... [COMMAND]
-u, --username username to login with
-p, --password password to login with
-H, --hostname hostname to login to
--log log file to capture debug information in
-x, --xml format output in XML
-V, --version display the version and exit
-h, --help display this message and exit
.
.
.

If you type a command that AVCLI does not recognize, AVCLI displays the preceding output.

Displaying Help for a Specific Command

To display help for a specific command, type:

$ avcli help command_name

For example, if you type:

$ avcli help vm-create

The output is:

Usage: avcli vm-create[--interfaces] [--shared-storage]
Create a new VM.
.
.
.

If you type a valid command with an invalid argument, AVCLI displays the same output as if you had specified help for the command.

of