CLI Commands (v2)

Note

This documentation is for CLI v2. If you are using CLI v3, refer to CLI Commands.

The general format for CONVERGE Horizon commands is:

horizon <command> [options] [arguments]

You can run the commands without specifying arguments at the command line. You will be prompted for any arguments that were not specified.

The following commands are available:

• batch:create (v2)
• batch:list (v2)
• batch:start (v2)
• batch:stop (v2)
• config:create (v2)
• config:show (v2)
• filesystem:list (v2)
• job:create (v2)
• job:list (v2)
• job:log (v2)
• job:scp (v2)
• job:show (v2)
• job:ssh (v2)
• job:stop (v2)
• job:terminate (v2)
• list (v2)
• project:list (v2)
• space:download (v2)
• space:list (v2)
• space:upload (v2)
• team:list (v2)
• team:switch (v2)
• update (v2)

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.

--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.

--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).