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:
curl https://raw.githubusercontent.com/kagent-dev/kagent/refs/heads/main/scripts/get-kagent | bash
Invoke-WebRequest -Uri https://github.com/kagent-dev/kagent/releases/latest/download/kagent_windows_amd64.zip -OutFile kagent.zip
Expand-Archive -Path kagent.zip -DestinationPath .\kagent
Move-Item .\kagent\kagent.exe C:\Windows\System32\
curl -LO https://github.com/kagent-dev/kagent/releases/latest/download/kagent_linux_amd64.tar.gz
tar -xzf kagent_linux_amd64.tar.gz
sudo mv kagent /usr/local/bin/
sudo chmod +x /usr/local/bin/kagent
  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 - make sure you set the OPENAI_API_KEY environment variable:

helm install kagent oci://ghcr.io/kagent-dev/kagent/helm/kagent \
    --namespace kagent \
    --create-namespace \
    --set openai.apiKey=$OPENAI_API_KEY \

Uninstallation

To remove kagent from your cluster:

$ kagent
kagent >> uninstall

Or, if you prefer Helm:

helm uninstall kagent

Next Steps