Kubetail CLI

The Kubetail CLI tool (kubetail) acts as an entry point into Kubetail on your desktop. Using the CLI tool you can start/stop the Kubetail Dashboard and perform other Kubetail-related operations on your cluster.

Install/Upgrade

Package Managers

macOS

Homebrew

To install kubetail with homebrew use this command:


brew install kubetail

By default homebrew will place the executable in a directory that’s already in to your path.

To upgrade kubetail just upgrade the package through homebrew:


brew update
brew upgrade

MacPorts

To install kubetail with MacPorts use this command:


sudo port install kubetail

To upgrade kubetail just upgrade the package through MacPorts:


sudo port upgrade kubetail

Linux

Ubuntu/Mint (apt)

To install kubetail from the Kubetail PPA on Ubuntu Launchpad, first install the add-apt-repository tool if you haven’t already:


sudo apt update
sudo apt install software-properties-common

Then install kubetail:


sudo add-apt-repository ppa:kubetail/kubetail
sudo apt update
sudo apt install kubetail-cli

To upgrade kubetail just upgrade the package through apt:


sudo apt update
sudo apt upgrade kubetail-cli

Arch Linux (AUR)

With AUR helper (recommended)

If you use an AUR helper like yay or paru , install kubetail from Arch Linux AUR with:


# yay
yay -S kubetail-cli
 
# paru
paru -S kubetail-cli

To upgrade kubetail just upgrade the package through your AUR helper:


# yay
yay -Syu kubetail-cli
 
# paru
paru -Syu kubetail-cli

Without AUR helper

To install kubetail manually from AUR:


git clone https://aur.archlinux.org/kubetail-cli.git
cd kubetail-cli && makepkg -si

To upgrade kubetail manually, repeat the process:


cd kubetail-cli
git pull
makepkg -si

Fedora/RHEL/CentOS (copr)

To install kubetail on Fedora/CentOS-Stream/RHEL (also Amazonlinux and Magea) with copr use this command:


dnf copr enable kubetail/kubetail
dnf install kubetail

To upgrade kubetail just upgrade the package through dnf:


dnf upgrade kubetail

SUSE (zypper)

To install kubetail with openSUSE zypper use these commands:


zypper addrepo 'https://download.opensuse.org/repositories/home:/kubetail/$releasever/' kubetail
zypper refresh && zypper install kubetail-cli

To upgrade kubetail just upgrade the package through zypper:


zypper refresh
zypper update kubetail-cli

Gentoo (GURU)

To install kubetail from the Gentoo GURU repository, first enable the GURU overlay if you haven’t already:


emerge --ask app-eselect/eselect-repository
eselect repository enable guru
emerge --sync guru

Then install kubetail:


ACCEPT_KEYWORDS="~$(portageq envvar ARCH)" emerge dev-util/kubetail

To upgrade kubetail just sync and upgrade the package through emerge:


emerge --sync
ACCEPT_KEYWORDS="~$(portageq envvar ARCH)" emerge --update dev-util/kubetail

Windows

Winget

To install kubetail with WinGet use this command:


winget install kubetail

To upgrade kubetail just upgrade the package through WinGet:


winget upgrade kubetail

Chocolatey

To install kubetail with Chocolatey use this command:


choco install kubetail

To upgrade kubetail just upgrade the package through Chocolatey:


choco upgrade kubetail

Scoop

To install kubetail with Scoop use this command:


scoop install kubetail

To upgrade kubetail just upgrade the package through Scoop:


scoop update kubetail

Cross-Platform

Krew

To install kubetail with krew use this command:


kubectl krew install kubetail

To upgrade kubetail just upgrade the plugin through krew:


kubectl krew upgrade kubetail

Snap

To install kubetail with snap you can use the Snap Store or this CLI command:


sudo snap install kubetail

To upgrade kubetail just refresh the snap package:


sudo snap refresh kubetail

Nix (Flake)

To install kubetail via a nix flake use this command:


nix profile add github:kubetail-org/kubetail-nix

To upgrade kubetail just upgrade the profile:


nix profile upgrade kubetail

Nix (Classic)

To install kubetail with nix classic use this command:


nix-env -i -f https://github.com/kubetail-org/kubetail-nix/archive/refs/heads/main.tar.gz

To upgrade kubetail just upgrade the package through nix-env:


nix-env -u kubetail

asdf

To install kubetail with asdf use this command:


asdf plugin add kubetail https://github.com/kubetail-org/asdf-kubetail.git
asdf install kubetail latest

To upgrade kubetail install the latest version and set it as global:


asdf install kubetail latest

Shell script

To install kubetail with a shell script you can run this command:


curl -sS https://www.kubetail.com/install.sh | bash

This will download our install.sh script and run it in one step. The script will automatically detect your OS/Arch, download the appropriate binary file and place it in your /usr/local/bin/ directory.

To upgrade kubetail just run the command again when a new version is available:


curl -sS https://www.kubetail.com/install.sh | bash

Download Binary

First, download the binary for your OS/Arch (from the latest release binaries ):

Next, rename the file and make it executable:


mv <filename> kubetail
chmod a+x kubetail

To upgrade kubetail just repeat the steps above when a new version is available.

Next Steps

To see the top-level commands just run kubetail:


kubetail

To start the Kubetail Dashboard use the serve sub-command:


kubetail serve

This command will start the dashboard server in your terminal and open http://localhost:7500/ in your default browser.

To view your Kubernetes logs use the logs sub-command:


kubetail logs

To enable advanced functionality in the dashboard, you can install the Kubetail cluster resources (e.g. Cluster API, Cluster Agent) using this command:


kubetail cluster install