Skip to main content

Download and Installation

In this section, you will find detailed instructions to install the STK CLI.


About STK CLI

STK CLI is StackSpot's command line interface tool. It is the main way for you to create and use StackSpot content, as well as access other Platform features.

STK CLI provides commands that make it easier to access and create StackSpot resources, without needing graphical environments or complex interfaces.

Before Installing

Prerequisites

Check the prerequisites to use STK CLI:

  1. Install Git version 2.32 or higher;
  2. Create an account on the StackSpot Portal.

    To access all available features on StackSpot, you must have an Account and log in to use STK CLI.

Configure your Git User

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

Step 1. Set up your username and email

Name:

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

Email:

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

Step 2. Verify the configuration

Run the following commands to check your settings:

git config --get user.name
git config --get user.email

If your username and email are displayed correctly in the terminal, proceed with the STK CLI Download and Installation guide. If the information is missing or needs correction, repeat Step 1.

Download STK CLI

Use Git Bash to run commands and improve your experience, such as enabling auto-complete.


To install the latest version of STK CLI:

  • Select your operating system;
  • Download the installer;
  • Follow the installation steps below.

Download the Windows Installer


StackSpot CLI is supported on the following Windows versions:

  • Windows 11
  • Windows 10

Installer link:


Step 1. Install STK CLI using the setup wizard


Go to the folder where you saved the stk.msi file. Double-click the file to start the installation. Follow the wizard instructions to complete the installation.


caution

After the installation, if you do not have a proxy configured, STK CLI will prompt you in the terminal to set up a proxy.
If you already have a proxy configured, this step will be skipped.

Restart the Terminal After Installation


If your terminal is open, close and reopen it after installation. This ensures the stk command is recognized.

In the terminal, run:

stk --version

If everything is set up correctly, the terminal will display the current STK CLI version.

If the stk command is not recognized, follow the steps below:

MacOS

In the MacOS terminal (Z shell - zsh), follow these steps:

  1. Add the lines below at the end of your .zshrc file by running:
export PATH=$HOME/.stk/bin:$PATH
test -f ~/.stk/bin/.zshrc && . ~/.stk/bin/.zshrc
  1. Restart the terminal;
  2. Run:
stk -v

Linux

In the Linux terminal, follow these steps:

  1. Run:
test -f ~/.stk/bin/.bash_profile && . ~/.stk/bin/.bash_profile
  1. Restart the terminal;
  2. Run:
stk -v

Authenticate STK CLI


To authenticate STK CLI, run:

stk login

Enter the email registered with the StackSpot Portal. You can also provide the email as a parameter:

stk login email-account@email.com

A screen will open in your default browser where you can enter your username and password. After confirming your login, return to the STK CLI to start your session.

Change STK CLI Language

The STK CLI language will match your operating system. Supported languages are Portuguese and English. If your system uses another language, the default will be English.

  1. To change the language, run:
stk config locale
  1. Select your preferred language.

Next Steps