Getting Started

Botkube includes a command-line interface (CLI) that you can use to interact with Botkube and Botkube Cloud from your terminal, or from a script.

Installation

Select tab depending on the system you use:

MacOS

curl -Lo botkube https://github.com/kubeshop/botkube/releases/download/v1.1.1/botkube_darwin_amd64

Copy to binary directory:

chmod +x botkube && mv botkube /usr/local/bin/botkube

Linux

curl -Lo botkube https://github.com/kubeshop/botkube/releases/download/v1.1.1/botkube_linux_amd64

Copy to binary directory:

chmod +x botkube && mv botkube /usr/local/bin/botkube

Windows

curl -Lo botkube https://github.com/kubeshop/botkube/releases/download/v1.1.1/botkube_windows_amd64.exe

For Windows, you will add it to the %PATH%.

Manual Download

To manually install Botkube CLI:

1. Download the binary for the version and platform of your choice from the GitHub releases page.

2. Move it to a location in the PATH. For example:

   mv botkube_linux_amd64 /usr/local/bin/botkube

   For Windows, you will need to add it to the %PATH%.

First use

For the commands that are nested under cloud command you first need to authenticate with Botkube cloud by running:

botkube login

If credentials are valid, the output is:

Login Succeeded

All available commands you can simply discover by running botkube --help or botkube <command> -h to see the help output which corresponds to a given command.

Autocompletion

To learn how to enable autocompletion for your shell, run:

botkube completion --help

NOTE: Be sure to restart your shell after installing autocompletion.

When you start typing a botkube command, press the <tab> character to show a list of available completions. Type -<tab> to show available flag completions.