README

!GitHub code size in bytes
!GitHub Workflow Status
!GitHub release (latest by date)







!GitHub last commit (branch)

k8sgpt is a tool for scanning your Kubernetes clusters, diagnosing, and triaging issues in simple English.

It has SRE experience codified into its analyzers and helps to pull out the most relevant information to enrich it with AI.

_Out of the box integration with OpenAI, Azure, Cohere, Amazon Bedrock, Google Gemini and local models._


 Sister project: Check out sympozium for managing agents in Kubernetes.


 




 Table of Contents
- Overview
- Installation
- Quick Start
- Analyzers
- Examples
- LLM AI Backends
- Key Features
- Model Context Protocol (MCP)
- Documentation
- Contributing
- Community

 CLI Installation

 Linux/Mac via brew

sh
brew install k8sgpt


or

sh
brew tap k8sgpt-ai/k8sgpt
brew install k8sgpt



  RPM-based installation (RedHat/CentOS/Fedora)

32 bit:

  

  
  sudo rpm -ivh https://github.com/k8sgpt-ai/k8sgpt/releases/download/v0.4.41/k8sgpt_386.rpm
  
  

64 bit:

  
  
  sudo rpm -ivh https://github.com/k8sgpt-ai/k8sgpt/releases/download/v0.4.41/k8sgpt_amd64.rpm
  
  



  DEB-based installation (Ubuntu/Debian)

32 bit:

  


curl -LO https://github.com/k8sgpt-ai/k8sgpt/releases/download/v0.4.41/k8sgpt_386.deb
sudo dpkg -i k8sgpt_386.deb


  

64 bit:

  


curl -LO https://github.com/k8sgpt-ai/k8sgpt/releases/download/v0.4.41/k8sgpt_amd64.deb
sudo dpkg -i k8sgpt_amd64.deb


  




  APK-based installation (Alpine)

32 bit:

  
  
  wget https://github.com/k8sgpt-ai/k8sgpt/releases/download/v0.4.41/k8sgpt_386.apk
  apk add --allow-untrusted k8sgpt_386.apk
  
  

64 bit:

  
  
  wget https://github.com/k8sgpt-ai/k8sgpt/releases/download/v0.4.41/k8sgpt_amd64.apk
  apk add --allow-untrusted k8sgpt_amd64.apk
  
  



  Failing Installation on WSL or Linux (missing gcc)
  When installing Homebrew on WSL or Linux, you may encounter the following error:


== Installing k8sgpt from k8sgpt-ai/k8sgpt Error: The following formula cannot be installed from a bottle and must be
built from the source. k8sgpt Install Clang or run brew install gcc.


If you install gcc as suggested, the problem will persist. Therefore, you need to install the build-essential package.


   sudo apt-get update
   sudo apt-get install build-essential




 Windows

- Download the latest Windows binaries of k8sgpt from the Release
  tab based on your system architecture.
- Extract the downloaded package to your desired location. Configure the system _PATH_ environment variable with the binary location

 Operator Installation

To install within a Kubernetes cluster please use our k8sgpt-operator with installation instructions available here

_This mode of operation is ideal for continuous monitoring of your cluster and can integrate with your existing monitoring such as Prometheus and Alertmanager._

 Quick Start

- Currently, the default AI provider is OpenAI, you will need to generate an API key from OpenAI
  - You can do this by runni