Command and Option References¶
The DKCloudCommand command line interface (CLI) provides many commands and options to perform DataOps work.
- Commands Reference: Lists and describes all CLI commands, their shortcuts, and options.
- Options Reference: Lists and describes all CLI command options and their shortcuts.
Note
CLI is case-sensitive: Use lowercase commands with the DKCloudCommand interface. The CLI is case-sensitive, even if your instance of shell is not.
Top-level command¶
Use the dk top-level command before calling any of the specific commands and options.
~ $ dk
Usage: dk [OPTIONS] COMMAND [ARGS]
Options:
--version Show the version and exit.
--help Show this message and exit.
Help¶
View details regarding any specific command by appending the --help option.
Output: kitchen-merge command with --help option
Usage: dk kitchen-merge [OPTIONS]
Merge two kitchens. Provide the names of the source and target kitchens.
Options:
-sk, --source_kitchen TEXT source (from) kitchen name
-tk, --target_kitchen TEXT target (to) kitchen name [required]
-y, --yes Force yes
--help Show this message and exit.
Contextual or explicit options¶
DKCloudCommand can interpret arguments provided by either the context of the user's current working directory or by their explicit provision as part of a command input.
Some commands accept arguments only from the context of the current working directory, some only as explicitly provided, and others accept arguments from either source. Use the --help option to view the options available for any given command.
Example using context and explicit arguments¶
Context
Context and shortcuts
Explicit and shortcuts