Pular para o conteúdo principal

Download e Instalação

Nesta seção, você encontra instruções detalhadas para instalar o STK CLI.


Sobre o STK CLI

O STK CLI é a ferramenta de interface de linha de comando (em inglês, CLI - Command Line Interface) da StackSpot. Com ele, você pode criar e utilizar conteúdos da StackSpot, além de acessar diversas funcionalidades da Plataforma.

O STK CLI possui comandos que facilitam o acesso e a criação de recursos da StackSpot, sem a necessidade de ambientes gráficos ou interfaces complexas.

Antes de instalar

Pré-requisitos

Verifique os requisitos necessários para utilizar o STK CLI:

  1. Instale o Git - versão 2.32 ou superior;
  2. Crie uma conta no Portal da StackSpot.

    Para acessar todos os recursos disponíveis na StackSpot, você precisa ter uma conta e realizar o login para usar o STK CLI.

Configurar usuário do Git

Após instalar o Git, configure o nome de usuário e o e-mail da sua conta do repositório. No terminal, execute os comandos a seguir:

Passo 1. Configurar nome de usuário e e-mail

Nome:

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

E-mail:

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

Passo 2. Verificar a configuração

Execute os comandos abaixo para conferir:

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

Se o nome de usuário e o e-mail forem exibidos corretamente no terminal, continue com o guia para download e instalação do STK CLI. Caso não apareçam ou seja necessário corrigir, repita o Passo 1.

Download do STK CLI

Utilize o Git Bash para executar os comandos, aproveitando recursos como o auto-complete.


Para instalar a versão mais recente do STK CLI:

  • Selecione o seu sistema operacional;
  • Faça o download;
  • Siga os passos de instalação indicados a seguir.

Download do instalador para Windows


O StackSpot CLI é homologado para as seguintes versões do Windows:

  • Windows 11
  • Windows 10

Link do instalador:


Passo 1. Instalar o STK CLI usando o assistente


Acesse a pasta onde o arquivo stk.msi foi salvo. Clique duas vezes no arquivo para iniciar a instalação. Siga as instruções do assistente de instalação até finalizar o processo.


Cuidado!

Após a instalação, caso você não tenha um proxy configurado, o STK CLI perguntará no terminal se deseja configurar um proxy.
Se você já possui um proxy configurado, essa etapa será ignorada.

Reiniciar o terminal após a instalação


Se o terminal estiver aberto, feche e abra novamente após a instalação. Isso garante que o comando stk seja reconhecido.

No terminal, execute:

stk --version

Se tudo estiver configurado corretamente, será exibido o número da versão do STK CLI.

Caso o comando stk não seja reconhecido, siga as instruções a seguir:

MacOS

No terminal do MacOS (Z shell - zsh), siga os passos abaixo:

  1. Adicione as linhas ao final do arquivo .zshrc executando, respectivamente:
export PATH=$HOME/.stk/bin:$PATH
test -f ~/.stk/bin/.zshrc && . ~/.stk/bin/.zshrc
  1. Reinicie o terminal;
  2. Execute novamente:
stk -v

Linux

No terminal do Linux, siga os passos abaixo:

  1. Execute:
test -f ~/.stk/bin/.bash_profile && . ~/.stk/bin/.bash_profile
  1. Reinicie o terminal;
  2. Execute novamente:
stk -v

Autenticar o STK CLI


Para autenticar o STK CLI, execute:

stk login

Informe o e-mail cadastrado no Portal da StackSpot. Você também pode informar o e-mail como parâmetro:

stk login email-account@email.com

Uma tela será aberta no seu navegador padrão para que você informe o usuário e a senha associados à sua conta. Após validar as informações e confirmar o login, retorne ao STK CLI para iniciar sua sessão.

Alterar o idioma do STK CLI

O idioma exibido no STK CLI será o mesmo do sistema operacional. Os idiomas suportados são Português e Inglês. Caso o sistema esteja em outro idioma, o padrão será o Inglês.

  1. Para alterar o idioma, execute:
stk config locale
  1. Selecione o idioma desejado.

Próximos passos