Skip to content

Command line interface overview

The kdb Insights Command Line Interface is a tool to manage your kdb Insights Enterprise application. Use it to:

  • Manage deployments

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

    The installation documentation describes how to do this in detail.

  • Manage assemblies

    You can programmatically create, manage and teardown assemblies.

    This functionality is available via the kxi assembly subcommand.

  • Manage packages

    You can create and manage packages that allow you to introduce custom logic into the kdb Insights Enterprise.

    Read the packaging documentation for more detailed information.

  • Azure

    You can interact with kdb Insights Enterprise on the Azure Marketplace.

    Read the Azure documentation for more detailed information about how the CLI can be used in this context.

Installing the CLI

To install the CLI, use the CLI installation guide.

Options precedence

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

  1. The command line parameter
  2. The value set in your local cli-config file
  3. The setting from the values file passed with --filepath (in the case of kxi install run/upgrade)
  4. The setting from the values file already deployed on cluster (in the case of kxi install upgrade)
  5. The response to a user prompt (in an interactive session)
  6. 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