Command Line Interface Overview

This page provides an overview of the kdb Insights Command Line Interface (CLI), a tool to manage your kdb Insights Enterprise application. Use it to:

  • Manage deployments

    You can install, upgrade, and uninstall kdb Insights Enterprise.

    Refer to kdb Insights Enterprise installation for more information.

  • Manage packages

    You can create and manage packages that enable you to manage the life cycle of deployments and custom logic in kdb Insights Enterprise.

    For more information, refer to Packaging.

Installing the CLI

To install the CLI, refer to the CLI installation guide.

Options precedence

The CLI reads each option value in the following order of precedence:

  1. The command line parameter

  2. Corresponding environment variables. This includes variables defined in a .env file.

  3. The value set in your local cli-config file

  4. The setting from the values file passed with --filepath (in the case of kxi install run/upgrade)

  5. The setting from the values file already deployed on cluster (in the case of kxi install upgrade)

  6. The response to a user prompt (in an interactive session)

  7. The default value

Namespace precedence

The namespace option precedence has an extra check and is read in the following order:

  1. The --namespace command line parameter

  2. The namespace value set in your local cli-config file

  3. The namespace set in your active Kubernetes context

  4. The response to a user prompt (in an interactive session)

  5. The default value