MacOS

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

Homologated Versions

STK 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 compatibility may not be complete.

Requirements

• Install Git - starting with version 2.32.
• Z shell (zsh): run the chsh -s /bin/zsh command in your terminal to enable zsh.
• Keep the Xcode Developer Tool up to date.
• Create an account on StackSpot Website.

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

Download

caution

After downloading, do not run the stk-legacy.pkg file. To proceed with the installation, follow the steps exactly.

Step 2. Do not run the stk-legacy.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 where the installer was downloaded;
2. Run the command:

installer -pkg stk-legacy.pkg -target CurrentUserHomeDirectory

caution

The value after -target is CurrentUserHomeDirectory, you don't need to replace it.

Step 3. Restart the terminal after installation

It makes sure that the stk-legacy command is recognized.

caution

It is necessary to terminate the terminal process before restarting it. Use Command + Q and then open the terminal again.

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 the 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.

Next steps

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