StackState Docs
v4.6
StackState.comDownloadSupportExplore playground
Search
⌃K
Links

StackState CLI

StackState Self-hosted v4.6.x
This page describes StackState version 4.6.
Go to the documentation for the latest StackState release.

Overview

The StackState CLI provides easy access to the functionality provided by the StackState APIs. It can be used to configure StackState, work with data, automate using StackState data and help with developing StackPacks. You can configure the CLI to work with multiple instances of StackState.

Install the StackState CLI

A standalone executable is available to run the StackState CLI on Linux and Windows. You can also run the CLI inside a Docker container on Linux, Windows or MacOS.

Linux install

The steps below describe how to install the StackState CLI on Linux using the standalone executable file. If you prefer, you can run the CLI inside a Docker container .
Requirements:
  • Access to the StackState APIs.
Installation:
  1. 1.
    Download the Linux executable sts-cli-VERSION-linux64 from https://download.stackstate.com.
  2. 2.
    Rename the downloaded file to be sts and make it executable:
    mv sts-cli-VERSION-linux64 sts
    chmod +x sts
  3. 3.
    (optional) Add the file to your PATH to use StackState CLI commands from anywhere on the command line.
  4. 4.
    To configure the StackState CLI, do one of the following:

Windows install

The steps below describe how to install the StackState CLI on Windows using the standalone executable file. If you prefer, you can run the CLI inside a Docker container .
Requirements:
  • Access to the StackState APIs.
Installation:
  1. 1.
    Download the executable sts-cli-VERSION-windows.exe from https://download.stackstate.com.
  2. 2.
    Rename the downloaded file to be sts.exe.
  3. 3.
    (optional) Add the file to your PATH to use StackState CLI commands from anywhere on the command line.
  4. 4.
    To configure the StackState CLI, do one of the following:

Docker install (Mac, Linux, Windows)

The StackState CLI can be run inside a Docker container on Linux, Windows or MacOS. The ZIP archive provided contains scripts that run the CLI without needing to worry about Docker invocations.
Requirements:
Installation:
  1. 1.
    Download the ZIP file sts-cli-VERSION.zip from https://download.stackstate.com.
    The ZIP archive contains the following files:
    .
    +-- bin
    | +-- sts # Script to run the CLI in Docker for bash
    | +-- sts.ps1 # Script to run the CLI in Docker for Powershell
    +-- conf.d
    | +-- conf.yaml.example # Example CLI configuration
    | +-- VERSION # The CLI version to retrieve from Docker hub
    +-- templates
    | +-- topology # Topology templates in a format specific to the CLI
    +-- release_notes.md # Changelog of the CLI
    +-- usage.md # How to configure and use this package
  2. 2.
    (optional) Add the bin directory to your PATH to use StackState CLI commands from anywhere on the command line.
  3. 3.
    To configure the StackState CLI, manually add configuration.

Configure the StackState CLI

After installation, the StackState CLI must be configured with the API connection details for your StackState instance. If you installed the standalone executable StackState CLI on Linux or Windows, a wizard is available to guide you through configuration. If you installed the Docker version of the StackState CLI on Mac, Linux or Windows, the configuration file must be manually created.

Configuration wizard (Linux and Windows install)

If the StackState CLI was installed on Linux or Windows using a standalone executable file, the first time you run any sts command, a configuration wizard will request the required configuration items. The wizard will then create a configuration file with the entered details and store it under the user's home directory. If a valid configuration file already exists, the StackState CLI will use this and the configuration wizard will not run.
The configuration wizard is not available when the CLI is run inside a Docker container on MacOS, Linux or Windows.
To configure the CLI, you will need your authentication credentials.
Example configuration wizard:
$ sts graph list-types
No config was found. Would you like to configure the CLI using this wizard? (Y/n): Y
​
StackState URL: https://company.stackstate.com/
Your API token (see https://company.stackstate.com/#/cli ):
Admin API URL (default: https://company.stackstate.com/admin):
Receiver API URL (default: https://company.stackstate.com/receiver):
Receiver API key (default: API_KEY):
Hostname used for receiver ingestion via the CLI (default: mycli):
​
Thank you! Config file saved to: /Users/myuser/.stackstate/cli/conf.yaml

Manual configuration (Docker)

The CLI configuration file can be manually created or edited using the steps below. This is required for a Docker install and optional for a Linux or Windows install using a standalone executable file.
  1. 1.
    Download the ZIP file sts-cli-VERSION.zip from https://download.stackstate.com. If you ran the Docker install, you can skip this step and use the ZIP archive you already downloaded.
  2. 2.
    Copy the file conf.d/conf.example.yaml from the ZIP archive and put it in one of the following directories:
    • Docker:
      • conf.d/ - relative to the directory where the CLI is run.
    • Linux or Windows:
      • conf.d/ - relative to the directory where the CLI is run.
      • ~/.stackstate/cli/ - relative to the user's home directory.
      • %APPDATA%/StackState/cli/ - relative to the user's home directory.
  3. 3.
    Rename the file to be conf.yaml.
  4. 4.
    Edit the file and add:
    • URLs to the StackState APIs.
    • Any required authentication details for the APIs. The base_api API has support for API tokens. You can copy your private API Token from the CLI page in the StackState UI.
    • Client details.
Example conf.yaml
## The CLI uses an instance of StackState for all its commands.
## Unless the `--instance` argument is passed the CLI will pick the `default` instance as configured below.
## Other instances follow the exact same configuration pattern as the instance below.
instances:
default:
base_api:
url: "https://stackstate.mycompany.com"
# Get the api token from the user interface, see https://stackstate.mycompany.com/#/cli
apitoken_auth:
token: '???'
## HTTP basic authentication.
#basic_auth:
#username: '???'
#password: '???'
receiver_api:
url: "https://stackstate.mycompany.com/receiver"
## HTTP basic authentication.
#basic_auth:
#username: '???'
#password: '???'
admin_api:
url: "https://stackstate.mycompany.com/admin"
# Get the api token from the user interface, see https://stackstate.mycompany.com/#/cli
apitoken_auth:
token: '???'
## HTTP basic authentication.
#basic_auth:
#username: '???'
#password: '???'
​
## The CLI uses a client configuration to identify who is sending to the StackState instance. The client
## is used to send topology and/or telemetry to the receiver API.
##
## Unless the `--client` argument is passed the CLI will pick the `default` instance as configured below.
## Other clients follow the exact same configuration pattern as the default client. You may simply copy-paste its config and modify whatever is needed.
clients:
default:
api_key: "API_KEY"
## The name of the host that is passed to StackState when sending. Leave these values unchanged
## if you have no idea what to fill here.
hostname: "hostname"
internal_hostname: "internal_hostname"

Add multiple configurations

The conf.yaml CLI configuration file can hold multiple configurations. Other StackState instances can be added on the same level as the default configuration. For example:
instances:
default:
base_api:
...
admin_api:
...
receiver_api:
...
clients:
...
Preproduction:
base_api:
...
clients:
...
To use the StackState CLI with a non-default instance, specify the instance name in the sts command:
sts --instance <instance_name> ...

Authentication

The StackState CLI uses three StackState APIs: the Base API, the Admin API and the Receiver API. These APIs are secured differently and need to have separate authentication details entered in the CLI configuration file.

API key - Receiver API

StackState receives topology, telemetry and trace data via the Receiver API. If you want to push information to StackState using the CLI, you will need to provide a Receiver API key. This is the same API key that is used by the StackState Agent and is available from your administrator.

API token - Base API and Admin API

Base API and Admin API authentication using username/password will be deprecated.
The CLI will issue a warning when username/password authentication is used for the Base API and the Admin API. It is recommended to switch to token based authentication as described below.
The StackState CLI authenticates against the Base API and the Admin API using a unique API token that is auto-generated for your StackState user account. The same API token should be entered in the CLI configuration file for both the Base API and the Admin API.
  • The Base API is used for most operations. All users have access to this API, although the available operations will be restricted in accordance with the permissions assigned to each role.
  • The Admin API is used for some operations that affect the global configuration of StackState, such as the configuration of StackGraph's retention. Only users with the permission access-admin-api will have access to the Admin API and the associated operations.
If you are using a custom tool instead of the CLI, you can authenticate with the same API token. For example, this can be done by including the following header in a curl request:
curl -H "Authorization: ApiToken <token>" <stackstate-api-endpoint>
You can find your API token in the StackState UI, go to Main menu > CLI.

Use the StackState CLI

For details on how to work with the StackState CLI, see the CLI reference guide or refer to the help provided in the CLI.
sts --help
Previous
Agent V1 (Legacy)
Next - Setup
Data management
Last modified 8mo ago