Installation

KubeGraf is distributed as a single binary with no dependencies. Choose your preferred installation method below.

Prerequisites: You need a working kubectl configuration with access to a Kubernetes cluster.

Installation Methods at a Glance

macOS

  • Homebrew (recommended)
  • Manual download (Apple Silicon or Intel)
  • Quick install script

Linux

  • Manual download (amd64 or arm64)
  • Quick install script
  • Works on all distros

Windows

  • GUI installer (recommended)
  • Scoop package manager
  • Manual ZIP download

Quick Install

The fastest way to install KubeGraf on macOS or Linux:

curl -sSL https://kubegraf.io/install.sh | bash

This script automatically detects your OS and architecture, downloads the appropriate binary, and installs it to /usr/local/bin.

macOS

Homebrew Recommended

The easiest way to install KubeGraf on macOS:

brew tap kubegraf/tap
brew install kubegraf

To upgrade: brew upgrade kubegraf

Apple Silicon (M1/M2/M3/M4)

For Macs with Apple silicon processors (2020+):

curl -LO https://github.com/kubegraf/kubegraf/releases/latest/download/kubegraf-darwin-arm64.tar.gz
tar xzf kubegraf-darwin-arm64.tar.gz
sudo mv kubegraf /usr/local/bin/

Note: You can verify your chip type by clicking the Apple menu () → About This Mac. If it says "Chip: Apple M1/M2/M3/M4", you have Apple Silicon.

Intel Processor

For Macs with Intel processors (typically pre-2020):

curl -LO https://github.com/kubegraf/kubegraf/releases/latest/download/kubegraf-darwin-amd64.tar.gz
tar xzf kubegraf-darwin-amd64.tar.gz
sudo mv kubegraf /usr/local/bin/

Note: You can verify your chip type by clicking the Apple menu () → About This Mac. If it says "Processor: Intel", you have an Intel-based Mac.

Linux

x86_64 / AMD64 Most Common

For standard Intel/AMD 64-bit Linux systems:

curl -LO https://github.com/kubegraf/kubegraf/releases/latest/download/kubegraf-linux-amd64.tar.gz
tar xzf kubegraf-linux-amd64.tar.gz
sudo mv kubegraf /usr/local/bin/

Check your architecture: Run uname -m. If it shows x86_64, use this version.

ARM64

For ARM-based 64-bit systems (Raspberry Pi 4/5, AWS Graviton, Oracle Ampere):

curl -LO https://github.com/kubegraf/kubegraf/releases/latest/download/kubegraf-linux-arm64.tar.gz
tar xzf kubegraf-linux-arm64.tar.gz
sudo mv kubegraf /usr/local/bin/

Check your architecture: Run uname -m. If it shows aarch64 or arm64, use this version.

Windows

Manual Download Recommended

Direct binary download without package manager - simple and fast.

Which version? Most Windows PCs use x64 (AMD64). Use ARM64 only for Surface Pro X, Windows on ARM devices, or Snapdragon-powered laptops.

After downloading:

  1. Extract the ZIP file to a folder of your choice (e.g., C:\kubegraf or C:\Program Files\kubegraf)
  2. Add the folder to your system PATH:
    • Open PowerShell as Administrator
    • Run: [Environment]::SetEnvironmentVariable("Path", $env:Path + ";C:\kubegraf", [EnvironmentVariableTarget]::User)
    • Replace C:\kubegraf with your actual folder path
    • IMPORTANT: Close all terminals and open a NEW Command Prompt or PowerShell
  3. Verify: Run kubegraf --version in your new terminal

💡 In-App Updates: The app UI supports updating directly from the interface. After clicking the update button, wait approximately 60 seconds for the update to complete.

📖 Need help with PATH? See the detailed PATH troubleshooting section below for step-by-step instructions and common issues.

GUI Installer

Graphical installation wizard with automatic PATH setup:

  1. Download Latest Installer (.exe) - Get the kubegraf-X.X.X-setup.exe file
  2. Double-click the downloaded .exe file to run the installer
  3. Follow the installation wizard (click Next, Accept, Install)
  4. Make sure "Add KubeGraf to PATH" is checked during installation
  5. IMPORTANT: Close any open terminals, then open a NEW Command Prompt or PowerShell window
  6. Start the application:
    • Option 1: The installer will automatically launch the app in your browser at localhost:3000
    • Option 2: Manually start from terminal with kubegraf web

💡 In-App Updates: The app UI supports updating directly from the interface. After clicking the update button, wait approximately 60 seconds for the update to complete.

⚠️ Windows SmartScreen Warning: When you download and run the installer, Windows may show a "Windows protected your PC" warning. This is normal for unsigned installers.

Learn How to Proceed →

What you get: Automatic PATH setup, Start Menu shortcuts, Desktop shortcut (optional), Professional uninstaller

Scoop Package Manager

For users with Scoop package manager installed

scoop bucket add kubegraf https://github.com/kubegraf/scoop-bucket
scoop install kubegraf

To upgrade: scoop update kubegraf

Verify Installation

After installation, verify KubeGraf is working:

kubegraf --version

You should see output like:

kubegraf version 1.0.0 (go1.21.0)

Need Help?

📖 Installation Issues?

Having trouble with installation? Check our comprehensive troubleshooting guide for solutions to common issues across all platforms.

View Troubleshooting Guide →

Next Steps

Now that KubeGraf is installed, check out the Quick Start Guide to connect to your first cluster.

Previous
Quick Start
Next
First Cluster