Documentation

Installing kagent

This guide covers ways to install and configure kagent in your Kubernetes environment. For a quick setup, check out our Quick Start Guide.

Installation Methods

Using kagent CLI (Recommended)

  1. Set the OpenAI API key as an environment variable:
export OPENAI_API_KEY="your-api-key-here"
  1. Download the kagent CLI:
# Download/run the install script
curl https://raw.githubusercontent.com/kagent-dev/kagent/refs/heads/main/scripts/get-kagent | bash
  1. Install kagent to the cluster using the CLI. First run the CLI:
kagent

Then, once within the CLI environment, run the install command:

install
kagent >> install
kagent installed successfully

Using Helm

Another way to install kagent is using Helm.

  1. Install the Helm chart with CRDs:
helm install kagent-crds oci://ghcr.io/kagent-dev/kagent/helm/kagent-crds \
    --namespace kagent \
    --create-namespace \
  1. Set the OPENAI_API_KEY environment variable:
export OPENAI_API_KEY="your-api-key-here"
  1. Install the kagent Helm chart:
helm install kagent oci://ghcr.io/kagent-dev/kagent/helm/kagent \
    --namespace kagent \
    --set providers.openAI.apiKey=$OPENAI_API_KEY \

Uninstallation

To remove kagent from your cluster:

$ kagent
kagent >> uninstall

Or, if you used Helm:

  1. Uninstall kagent chart:
helm uninstall kagent -n kagent
  1. Optionally, remove all kagent CRDs and resources:
helm uninstall kagent-crds -n kagent

Note that uninstalling the kagent-crds chart deletes all kagent resources across all namespaces.

Next Steps