Install
In this section, you will find:
About
STK CLI is StackSpot's command line interface. It is the main channel and allows you to use and create content in the platform. You can also access all features.
STK CLI has commands to help create StackSpot's resources.
Install
Before installing
Requirements
See the requirements to install and use STK CLI:
- Install Git - starting with 2.32. version.
- Create an account on StackSpot website. To access every available resource on StackSpot, create an account and log in to use STK CLI.
Download
Choose your Operating System and click on the link below to download:
Existem cenários em que você precisa acessar mais de uma conta.
Quando precisar trocar para uma conta de outra organização pelo STK CLI você não deve fazer um novo login com a sessão atual ativa, antes você deve encerrar a sua sessão com o comando stk logout.
Em seguida, faça o login novamente com o comando stk login informando o email da conta da outra organização.
Setup your Git user
After installing Git, configure the user and email address of your repository account. On your terminal, execute the following commands:
Step 1. Configure your username and email address
Name:
git config --global user.name "{username}"
E-mail:
git config --global user.email "{email}"
Step 1. Check the configuration
Execute the commands below:
git config --get user.name
Then:
git config --get user.email
If your Git repository account username and email address were displayed in the terminal, follow the getting started section. If there was an error, or you need to correct information, go back to Step 1.
Execute the installing package
Use Git Bash to execute the commands and have a better experience (like the auto-complete feature).
To install the latest STK CLI version, download the installer. Select your operating system and run the commands on your terminal:
- Instalar no Windows
- Linux
- MacOS
Supported Versions
StackSpot CLI works on the following Windows versions:
- Windows 11
- Windows 10
Step 1. Follow the wizard instructions on your computer
Go to the folder where you placed the stk.msi file.
Double-click on the file to start the installation. Follow the wizard instructions on your computer and finish the installation.
Step 2. Restart the terminal after installation
If the terminal is open, close it and open it again after installing it. It makes stk command works.
Execute the command:
stk --version
If it's all correct, the terminal returns the current STK CLI version.
Step 3. Authenticate STK CLI
Execute the following command:
stk login
Add your e-mail registered on the StackSpot website. You can inform your email as a parameter with the command below:
stk login email-account@email.com
A screen opens in your current browser, you need to inform your StackSpot user and password. After confirmation, return to STK CLI to begin your session.
Supported Linux distro
StackSpot CLI works on the following Linux distros:
- Ubuntu 20.04
- Ubuntu 18.04
- Red Hat Enterprise Linux (RHEL)
There are no installation requirements for other versions, but STK CLI may not work.
Step 1. Go to the folder where the installation package is
In your terminal go to the folder. For stk.deb file, run the command:
sudo dpkg --install stk.deb
For stk.rpm file, execute the command:
rpm -i stk.rpm
For RHEL, execute the command below:
sudo rpm -i
If you don’t have root user permission, install via script:
curl -fsSL https://stk.stackspot.com/install.sh | bash
Step 2. Restart the terminal
If the terminal is opened, close it and open it again after installing it. It will help the stk command to work.
- It is necessary to stop the terminal process before restarting it.
On your terminal, execute the command:
stk --version
If it's all correct, the terminal returns the current STK CLI version.
Step 4. Authenticate STK CLI
Execute the command below:
stk login
Add your e-mail registered on the StackSpot website. You can inform your email as a parameter with the command below:
stk login email-account@email.com
A screen opens in your current browser, you need to inform your StackSpot user and password. After confirmation, return to STK CLI to begin your session.
Supported Versions
StackSpot CLI works on the following MacOS versions:
- MacOS 12 (Monterey)
- MacOS 11 (Big Sur)
There are no installation requirements for other versions, but STK CLI may not work.
Before you begin, follow steps:
- Z shell (zsh): Execute the
chsh -s /bin/zshcommand on your terminal to enable zsh. - Keep the Xcode Developer Tool up to date.
Step 1. Do not run the stk.pkg file from the UI (two clicks on the file). You must open the terminal and follow the instructions below:
1. Go to the directory you downloaded the installer;
2. Execute the command:
installer -pkg stk.pkg -target CurrentUserHomeDirectory
The value after -target is CurrentUserHomeDirectory, you don't need to replace it.
Step 2. Restart the terminal, It makes sure the stk command is working
It is necessary to stop the terminal process before restarting it. Use Command + Q and then open the terminal again.
On the terminal, execute:
stk --version
If it's all correct, the terminal returns the current STK CLI version.
Step 3. Authenticate STK CLI
Execute the command below:
stk login
Add your e-mail registered on the StackSpot website. It is also possible to inform the email as a parameter in the command:
stk login email-account@email.com
A screen opens in your current browser, you need to inform your StackSpot user and password. After confirmation, return to STK CLI to begin your session.
Was this page helpful?