Command structure
Each CLI command consists of a primary keyword (dsctl), command group, operations, and optional parameters.
dsctl <command_group> <operations> [-<parameter>]
- Primary key word - The primary keyword is always dsctl.
- Command group - The primary action (such as connect, list, logs). In this document, each command group has its own section.
- Operations - Secondary actions associated with the command group.
- Parameters - Any optional, positional, or required named parameters.
Global flags
Global flags are optional parameters that are associated with all command groups or sub-commands. The following global flags are available:
|
Configuration file |
|
Help option for current command or sub-command |
|
Log level (default "info") |
Field descriptions
Field descriptions defines fields used to describe the CLI commands. Not all fields may be applicable for all commands.
Field |
Description |
---|---|
Synopsis |
Defines the syntax for the CLI command including any optional, positional, or required parameters. |
Description |
Describes the command. |
Options |
Defines any optional parameters associated with the command group or sub-command. Global flags are not described here. See Global flags for details. Mandatory fields are noted. |
Examples |
Provides select examples for reference. |