CLI Commands

In CLI v3, the general format for CONVERGE Horizon commands is:

horizon <command> [options]

All values are passed as options. If you omit an option required to execute the command, you will be prompted for that option. Pass --no-interaction to suppress the prompts, in which case you must pass every required option at the command line.

Some options can be passed more than once to supply multiple values (for example, --status="running" --status="pending"). These options are marked as repeatable.

Category	Commands
Batches	batch:create, batch:list, batch:show, batch:start, batch:stop
Configuration	config:create, config:show, update
File systems	filesystem:create, filesystem:delete, filesystem:download, filesystem:list, filesystem:show, filesystem:upload
Jobs	job:create, job:list, job:log, job:scp, job:show, job:ssh, job:stop
Lookup	application:list, datacenter:list, node:list
Projects	project:create, project:list, project:show
Spaces	space:delete, space:download, space:list, space:show, space:upload
Teams	team:list, team:show, team:switch
Workstations	workstation:create, workstation:delete, workstation:list, workstation:show

General CLI Options

All commands support the general options listed below. Refer to the documentation of individual commands for options that are specific to those commands.

--help, -h

Show help text for the command, including its full list of options.

--silent

Do not show any output messages.

--quiet, -q

Show only error messages. Suppress all other output.

--version, -V

Show CLI version.

--ansi

Enable ANSI output (default).

--no-ansi

Disable ANSI output.

--no-interaction, -n

Do not show interactive prompts. Any option the command needs must be supplied at the command line.

--env=ENV

Run the command under the environment specified in ENV.

--verbose=1|2|3, -v|-vv|-vvv

Set the verbosity of output messages.

1 = Normal,

2 = More verbose,

3 = Most verbose (used for debugging).