cpd-cli command syntax conventions
The cpd-cli commands use arguments and options. Each command
has a syntax that designates both the required and optional arguments and options.
Command syntax conventions
The following table describes the conventions that are used in the cpd-cli command syntax.
| Syntax convention | Description | Example |
|---|---|---|
| Command | A command is the first word or set of consecutive words. | cpd-cli
backup-restore
init |
| Argument | If applicable, the words that follow the command are arguments. Arguments are typically written with capitalized letters and use underscore characters to separate the words. Arguments are required when brackets ([ ]) are not used around the arguments. | PRIVATE_REGISTRY_LOCATION |
| Option | An option is a character, a set of consecutive characters, or a word that follows the command and any arguments. Most options use longer, more descriptive names and are preceded by a double dash (--). Some options are preceded by a single dash (–). Options are required when brackets ([ ]) are not used around the options. Some options can have both a short and a long name. |
|
| Variable | A variable is any set of consecutive characters or words that follow an option. Variables are preceded by a dollar sign ($) and typically use capitalized letters in the character string to aid in reading comprehension. | ${PROJECT_CPD_INST_OPERANDS} |
| Brackets ([ ]) | Bracket use around an argument, option, or variable indicates that the argument, option, or variable is optional. | [-n] |
| Braces ({ }) | Braces identify a set of mutually exclusive options, when one option is required. | {true|false} |
| Angle brackets (< >) | Angle brackets indicate text that must be
replaced by whatever it represents. In the provided example, the user would replace
<file-name> with the name of the specific file. |
<file-name> |
| Vertical bars ( | ) | Mutually exclusive options are separated by a vertical bar ( | ). | info|debug|warn|error|panic |
| Ellipsis (...) | An ellipsis (…) indicates that the previous option can be repeated multiple times with different values. It can be used inside or outside of brackets. | <key1=value1,key2=value2,...> |