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

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

Shell

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