Skip to main content

Konfig CLI

Konfig CLI is a command-line tool which provides much of the same functionality as Konfig UI in a textual format. It is a single binary which provides commands to interact with your Control Plane and the Platforms, Domains, Workloads, and resources contained within it, i.e. the Konfig hierarchy. This allows you to quickly navigate parts of your organization and view the state of your infrastructure across product lines or business units from the command line.

$ konfig domains list ecommerce
ID        NAME      ENVIRONMENTS  CREATED                        READY
menu      Menu      dev           2024-06-07 20:53:55 +0000 UTC  TRUE
ordering  Ordering  dev           2024-06-07 19:58:50 +0000 UTC  TRUE
payment   Payment   dev           2024-06-07 19:58:50 +0000 UTC  TRUE
$ konfig workloads list ecommerce menu
ID            CREATED                        RUNTIME     RESOURCES  READY
discount-api  2024-08-12 19:30:46 +0000 UTC  RunService  1          TRUE
menu-api      2024-08-12 19:52:48 +0000 UTC  RunService  3          TRUE

Installing the CLI​

Coming Soon

Initializing the CLI​

Coming Soon

Command Help​

For complete documentation on Konfig CLI, run konfig --help. This will show a list of all available commands. You can also use --help with commands and subcommands to get more detailed usage information on them, e.g. konfig domains --help and konfig domains create --help.