---

A highly extensible platform for developers to better understand the complexity of Kubernetes clusters.

Octant is a tool for developers to understand how applications run on a Kubernetes cluster. It aims to be part of the developer's toolkit for gaining insight and approaching complexity found in Kubernetes. Octant offers a combination of introspective tooling, cluster navigation, and object management along with a plugin system to further extend its capabilities.

Getting Started

Installation

Package (Linux only)

1. Download the .deb or .rpm from the releases page.

2. Install with either dpkg -i or rpm -i respectively.

Windows

Chocolatey

1. Install using chocolatey with the following one-liner:

   choco install octant --confirm
   Copy

Scoop

1. Add the extras bucket.

   scoop bucket add extras
   Copy

2. Install using scoop.

   scoop install octant
   Copy

macOS

Homebrew

1. Install using Homebrew with the following one-liner:

   brew install octant
   Copy

Download a Pre-built Binary (Linux, macOS, Windows)

1. Open the releases page from a browser and download the latest tarball or zip file.

2. Extract the tarball or zip where X.Y is the release version:

   $ tar -xzvf ~/Downloads/octant_0.X.Y_Linux-64bit.tar.gz
   octant_0.X.Y_Linux-64bit/README.md
   octant_0.X.Y_Linux-64bit/octant
   Copy

3. Verify it runs:

   $ ./octant_0.X.Y_Linux-64bit/octant version
   Copy

Nightly Builds

Nightly builds of Octant are available for download.

Please note that nightly builds maybe less stable than our tagged releases and are intended to allow early access to preview upcoming features and for plugin authors who want access to the latest plugin APIs.

Browse nightly builds