Skip to main content
Version: v4.5.0

Linux

To install the latest STK CLI version, download the installer and run it in your terminal.

Homologated Distributions​

STK CLI works on the following Linux distributions:

  • Ubuntu 20.04
  • Ubuntu 18.04

There are no installation requirements for other versions, but STK CLI compatibility may not be complete.

caution

At the moment, Amazon Linux distribution is not compatible with STK CLI.

Requirements​

Set up your Git user​

After installing Git, configure the user and email address of your repository account. In the terminal, run the following commands:

Step 1. Set up your username and email address​

Name: 

git config --global user.name "{username}"

E-mail: 

git config --global user.email "{email}"

Step 2. Check the configuration​

Run the following commands: 

git config --get user.name

Next: 

git config --get user.email
info

If your Git repository account username and email address were displayed in the terminal, go to the Quickstart section. If there was an error, repeat [Step 1] to correct it.

Follow the steps below to install STK CLI:​

Step 1. Download STK CLI​

Step 2. Go to the folder where the installation package is​

In your terminal go to the folder. For stk-legacy.deb file, run the command:

sudo dpkg --install stk-legacy.deb

For stk-legacy.rpm file, run the command:

rpm -i stk-legacy.rpm

Step 3. Restart the terminal after installing​

If the terminal is open, close it and open it again after installing it. It will help the stk-legacy command get recognized.

caution

You must finish the terminal process before restarting it.

In the terminal, run the command: 

stk-legacy --version
caution

If STK CLI activation didn't work, whenever you run a command in the terminal, you will receive an alert to activate the code. For more details about the activation code, check Step 1 again.

If everything is configured, the terminal returns the current STK CLI version number.

Step 4. Authenticate the STK CLI​

To authenticate STK CLI, run the command below:

stk-legacy login

The command will ask for your account email, enter the email registered on the StackSpot Website. It is also possible to inform the email as a parameter:

stk-legacy login <email-account@email.com>

A screen will open in your default browser for you to enter the username and password associated with the account. After validating the information and confirming the login, return to the STK CLI where your session will start.

Use a Docker image with the STK CLI installed​

You can use a Docker image with the STK CLI installed. StackSpot offers two Linux versions on the following distributions:

  1. STK CLI Ubuntu
  2. STK CLI Debian

To use it, pull the image with the command found in the Docker Pull Command field in the repository of each image.

Next steps​

Now you can start using STK CLI, check Quickstart section.

Was this page helpful?