Syntax

SCLI syntax follows these rules:

Format

The following command syntax is mandatory:

scli --cmd_name

Parentheses ( ) indicate a group of required parameters, from which you must choose one.

Angle brackets <> indicate an argument.

Braces { } indicate a series of options for parameter values, from which you must choose one.

A “pipe” | is used to separate items in a series of options (parameters or parameter values). Select one of them.

Square brackets [ ] indicate an optional parameter.

Usage

Each command entry uses the above syntax and looks similar to the following example:

scli --cmd_example --r1 (--r2 | --r3 <V1>) [o1 <V2> | o2 {--so1 <V3> | --so2 }] [Options]

Parameter description

--r1
The r1 parameter description
--r2
The r2 parameter description
--r3<V1>
The r3 parameter description with possible <V1> input values
--o1<V2>
The o1 description with possible <V2> input values
--o2 {--so1 <V3> | --so2 }
The o2 description
[Options]
Additional optional parameters:
so1 <V3>
The so1 description with possible V3 input values
so2
The so2 description

Interpretation

  • The text scli --cmd_example r1 is mandatory. In commands that have no parameters, just scli --cmd_example is necessary.
  • (--r2 | --r3 <V1>) indicates that you must choose one of the options separated by “|”. Selecting an option is REQUIRED, as indicated by “( )”.
  • [o1 <V2>| o2 {--so1 <V3> | --so2}] indicates that you may choose one of the options separated by “|”. Selecting one of these options is OPTIONAL, as indicated by “[ ]”.
  • [Options] indicates that you may choose from the following additional parameters. It is OPTIONAL, as indicated by “[ ]”.