CLI: sts
StackState Self-hosted v5.1.x
Overview
The new StackState sts
CLI provides easy access to the functionality provided by the StackState APIs. It can be used for automate using StackState data, configure StackState and to develop StackPacks.
The new
sts
CLI replaces thestac
CLI, however, not all commands are currently supported. For an overview of the differences and overlap between the newsts
CLI and thestac
CLI, see the CLI comparison page.In the meantime, you can install and run as the new
sts
CLI on the same machine as thestac
CLI.
Install the new sts
CLI
sts
CLIThe new sts
CLI works with StackState version 5.0 and above.
If you are running an older version of StackState, use the stac
CLI.
If it's installed, upgrade the old
sts
CLI tostac
:Follow the steps below to install the new
sts
CLI:
Open a Powershell terminal (version 5.1 or later), change the <URL>
and <API-TOKEN>
and run the command below. After installation, the sts
command will be available for the current user on both the Powershell terminal and the command prompt (cmd.exe).
. { iwr -useb https://dl.stackstate.com/stackstate-cli/install.ps1 } | iex; install -StsUrl "<URL>" -StsApiToken "<API-TOKEN>"
Alternatively, go to the CLI page in the StackState UI and copy the Quick installation command for Windows - this is pre-filled with the correct <URL>
and <API-TOKEN>
for your StackState instance.
Configure the new sts
CLI
sts
CLIQuick start
The most secure way to use your API token is through an environment variable. You can store the API token with a secrets manager and inject it as an environment variable into your shell.
Linux, macOS and Windows
In the StackState UI, go to Main menu > CLI and copy your API token.
Run the command below, where
<URL>
is the URL to your StackState instance and<API-TOKEN>
is the API token you copied from the CLI page in the StackState UI:sts context save --name <NAME> --url <URL> --api-token <API-TOKEN>
The connection to your StackState instance will be tested and a configuration file stored at
~/.config/stackstate-cli/config.yaml
.
Docker
The Docker version of the CLI can't be configured with a config file. Specify the configuration of your StackState instance using environment variables and pass these to Docker:
STS_CLI_URL
- the URL to your StackState instance.STS_CLI_API_TOKEN
- the API token taken from the StackState UI Main menu > CLI page.
For example:
docker run \
-e STS_CLI_URL \
-e STS_CLI_API_TOKEN \
stackstate/stackstate-cli2 settings list --type Layer
Authentication
API token
By default, the CLI will authenticate using the API token that you provided when the CLI configuration was saved.
Service tokens
You can optionally use the CLI to create one or more service tokens to authenticate with the StackState Base and Admin APIs. For example, a service token can be used to authenticate in CI (Continuous Integration) scenarios where no real user is doing the operations on the StackState instance.
To create a service token, run the command below:
sts service-token create --name <NAME> --roles <ROLE(s)> [--expiration <yyyy-MM-dd>]
This will create a new service token and print it. The --expiration
parameter is optional and can be used to set the expiration date of the service token.
Once you have this, you can configure the CLI to use it:
sts context save --name <NAME> --service-token <TOKEN> --url <URL>
Manage multiple contexts
The new sts
CLI supports configuration and management of different (authentication) contexts. This enables you to easily switch between an administrative and regular user, or to switch between different StackState instances. For example, you could use a different context for a test and production instance of StackState. You can list, save, delete, set and validate contexts in the new sts
CLI. Run sts context -h
for details of the available commands and their usage.
Configuration options
You don't need a configuration file to run the new sts
CLI. You can also configure the CLI through a combination of environment variables and flags.
If multiple types of configuration are presented to the CLI the order of processing will be:
Flags
Environment variables
Config file
STS_CLI_URL
--url
URL to your StackState instance.
STS_CLI_API_TOKEN
--api-token
API token to your StackState instance. The most secure way to use your API token is through an environment variable. You can store the API token with a secrets manager and inject it as an environment variable into your shell.
STS_CLI_SERVICE_TOKEN
--service-token
A service token to your StackState instance. The most secure way to use your service token is through an environment variable. You can store the service token with a secrets manager and inject it as an environment variable into your shell.
STS_CLI_API_PATH
n/a
The path appended to the end of the URL to get the API endpoint. (Defaults to /api
)
STS_CLI_CONTEXT
--context
The name of the context to use.
Next to overriding specific parts of the config file, it's also possible to override the default config file location. This is done through the --config <PATH>
flag.
Upgrade
To upgrade to the latest version of the new sts
CLI, run the install command again.
You can check the version of the sts
CLI that you are currently running with the command sts version
.
Uninstall
Follow the instructions below to uninstall the StackState CLI.
Open a Powershell terminal and run:
. { iwr -useb https://dl.stackstate.com/stackstate-cli/install.ps1 } | iex; uninstall
The new sts
CLI and all associated configuration are now removed for the current user.
Open source
The StackState sts
CLI is open source and can be found on GitHub at:
Last updated