Getting Started
Botkube includes a command-line interface (CLI) that you can use to interact with Botkube from your terminal, or from a script.
Installation​
Select tab depending on the system you use:
- Mac with Apple Silicon
- Mac with Intel chip
- Linux
- Windows
- Other
Use Homebrew to install the latest Botkube CLI:
brew install kubeshop/botkube/botkube
Alternatively, download the Botkube CLI binary and move it to a directory under your $PATH:
curl -Lo botkube https://github.com/kubeshop/botkube/releases/download/v1.14.0/botkube-darwin-arm64
chmod +x botkube && mv botkube /usr/local/bin/botkube
Use Homebrew to install the latest Botkube CLI:
brew install kubeshop/botkube/botkube
Alternatively, download the Botkube CLI binary and move it to a directory under your $PATH:
curl -Lo botkube https://github.com/kubeshop/botkube/releases/download/v1.14.0/botkube-darwin-amd64
chmod +x botkube && mv botkube /usr/local/bin/botkube
Download the Botkube CLI binary and move it to a directory under your $PATH:
curl -Lo botkube https://github.com/kubeshop/botkube/releases/download/v1.14.0/botkube-linux-amd64
chmod +x botkube && mv botkube /usr/local/bin/botkube
You may need to use sudo to run the mv command as it moves the binary file to the /usr/local/bin/ directory.
Alternatively, if you use Homebrew, you can use it to install the latest Botkube CLI:
brew install kubeshop/botkube/botkube
Use curl to download the Botkube CLI binary:
curl -Lo botkube https://github.com/kubeshop/botkube/releases/download/v1.14.0/botkube-windows-amd64.exe
Move the binary to a directory under your %PATH%.
Use curl to download the Botkube CLI binary:
export OS="" # allowed values: darwin, linux, windows
export ARCH="" # allowed values: amd64, arm64, armv7
#export SUFFIX=".exe" # uncomment if OS is 'windows'
curl -Lo botkube https://github.com/kubeshop/botkube/releases/download/v1.14.0/botkube-${OS}-${ARCH}${SUFFIX}
Move the binary to a directory under your PATH.
First use​
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.