The Statehub CLI
kubectl is the most useful tool to manage Kubernetes clusters, the Statehub CLI is used to control your Statehub organizaion. While most operations can be performed with the Statehub Management Console (https://console.statehub.io/), some operations require the CLI.
Getting the Statehub CLI
To install Statehub run the following command on Linux or macOS:
curl https://get.statehub.io/get-statehub.sh | sh
- Download the Statehub CLI, and install it in your
statehub loginto authenticate your CLI installation and generate a token (in case a valid token is not installed on the system)
If you do not want to your
$PATH modified, or to perform authentication automatically, download the CLI installer:
wget -O get-statehub.sh https://get.statehub.io
Then, you can run it with
-n to prevent login, or with
--no-modify-path to prevent
sh get-statehub.sh -n --no-modify-path
Authenticating the CLI
In order for the Statehub CLI to function, it needs to be authenticated against your Statehub account. By default, the installation process prompts you to perform a login upon successful installation. However, in advanced cases, login can be performed manually in one of the following ways:
Perform an interactive login
To perform an interactive login, run
The CLI will prompt you with a link to the Statehub Management Console that will generate a token for your CLI installation, which you should copy from your browser, and paste to the CLI prompt.
To perform an interactive login, only in case no valid token is available to the CLI, run
statehub login --check
Generating a token manually and updating the configuration file
This process is useful for automated installations, CI/CD pipelines and other unattended processes. It requires you to obtain a token by following the procedure described in Access Tokens. Once you have your token, run:
Add the following line to the to the configuration file at
xxxwith your token):
token = 'xxx'
If the configuration file contains a valid token, the installation process will not prompt for an interactive login. Thus, you can put a valid configuration file at
~/.statehub/config.tomlprepopulated with a token, and then install the CLI in automation scenarios.
Using an environment variable to authenticate
You can use the
SHTOKENenvironment variable to store your token when running the Statehub CLI in ephemeral environments like CI/CD pipelines.
As with the configuration file, installation will skip interactive login if the
SHTOKENenvironment variable contains a valid token, making this an option running the CLI from within automated processes.
Updating the CLI
To update the Statehub CLI, either perform the installation procedure outlined in Getting the Statehub CLI or run: