Troubleshooting

Nesta seção, você encontra soluções para possíveis problemas no STK CLI.

Confira abaixo os possíveis erros que você pode ter ao utilizar o STK CLI e como você pode resolvê-los:

Erro de permissão do Git quando eu executo alguns comandos do STK CLI

Possível Causa
Os usuários possuem permissão nos repositórios Git, mas em alguns repositórios separados isso não acontece.

Solução
Verificar as suas permissões do Git antes de executar o comando e entre em contato com o administrador do repositório. Para mais informações, confira a documentação do GitHub.


Acabei de configurar o STK CLI e aparece o erro zsh: permission denied: stk

Possível Causa
É um problema específico do MacOS com a VPN privada.

Solução
Execute o comando abaixo no seu terminal:

chsh -s /bin/zsh

No xcrun. Exemplo: xcrun: error: invalid active developer path

Possível Causa
É um problema de atualização do MacOS.

Solução
Atualize o Xcode Developer Tool: xcode-select --install e tente novamente.


Tentei usar o código de ativação e ocorreu o seguinte erro: [WinError 2] O sistema não pode encontrar o arquivo especificado Traceback (most recent call last)

Possível Causa

O STK CLI utiliza o wmic do Windows para obter as informações do ID da máquina, o erro ocorre quando o PATH onde se encontra o wmic é alterado ou inexistente retornando a mensagem abaixo:

[WinError 2] O sistema não pode encontrar o arquivo especificado
Traceback (most recent call last):
  File "core\activation.py", line 79, in __check_machine_id
  File "metrics\metricsbuilder.py", line 21, in __init__
  File "metrics\metricsbuilder.py", line 54, in __get_machine_id
  File "subprocess.py", line 420, in check_output
  File "subprocess.py", line 501, in run
  File "subprocess.py", line 966, in __init__
  File "subprocess.py", line 1435, in _execute_child
FileNotFoundError: [WinError 2] O sistema não pode encontrar o arquivo especificado

Solução

Para modificar a variável de ambiente PATH do Windows, siga os passos abaixo:

1. Clique com o botão direito do mouse em Meu Computador (na área de trabalho ou no menu Iniciar). Em seguida, clique em Propriedades.
2. Na caixa de diálogo Propriedades do sistema, clique na guia Avançado.
3. Clique em Variáveis de ambiente.
4. Na lista superior, role para baixo até a variável PATH, selecione-a e clique em Edit.
5. Na caixa Valor da variável, navegue para o final da variável. Se não houver ponto e vírgula (;) no final do caminho atual, adicione um e, em seguida, insira o caminho: c:\windows\system32\wbem.
6. Clique em OK para fechar cada uma das caixas de diálogo.


Instalei o STK CLI para MacOS, mas sempre é solicitado a permissão de administrador

Possível Causa

A instalação do STK CLI via interfáce gráfica (dois cliques no arquivo stk.pgk). Não é recomendado instalar via interface gráfica, o MacOS faz a instalação para o usuário root e gera diversos problemas relacionados a permissão de administrador.

Solução

Instalar o STK CLI pelo terminal. Siga os passos abaixo:

1. Desinstale o STK CLI, execute no terminal o comando:

sh ~/.stk/bin/uninstall.sh

Uma mensagem aparece para confirmar a desinstalação antes que ela se inicie.

2. Ainda no terminal, acesse o diretório onde o instalador está e execute o comando abaixo:

installer -pkg stk.pkg -target CurrentUserHomeDirectory

Erros relacionados aos comandos do STK CLI

stk add plugin/ & stk add template

stk add <plugin/template> must run inside a stack folder created by stk create stack command!

Possível Causa Execução do comando stk add plugin/stk add template fora de uma Stack (não tem arquivo stack.yaml).

Solução
Criar uma Stack por meio do comando stk create stack e executar o stk add plugin/stk add template dentro da pasta criada.


A directory named <nome-plugin/nome-template> already exists in this stack. Remove it before proceeding.

Possível Causa Ao executar os comandos stk add plugin ou stk add template usando o path dentro de uma Stack que já tem um Plugin ou Template com o mesmo nome.

Solução

  1. Apagar a pasta do Plugin ou Template com mesmo nome.
  2. Alterar o nome do Plugin ou Template que está sendo adicionado.

A <plugin/template> named already exists in this stack at dir <nome_stack>. Remove it before proceeding

Possível Causa Executar os comandos add plugin ou add template dentro de uma Stack que já possui um Plugin ou Template com o mesmo nome.

Solução

  1. Apagar a pasta do Plugin ou Template com mesmo nome.
  2. Alterar o nome do Plugin ou Template que está sendo adicionado.

Can’t clone “” git repository:

Possível Causa Ao executar os comandos add plugin ou add template não foi possível clonar o repositório remoto.

Solução
Verificar se você possui permissão para clonar o repositório e se seu Git está configurado adequadamente.


Error ocurred while adding <plugin/template> to stack: <erro-lançado-pelo-git>

Possível Causa Ao executar os comandos add plugin ou add template ocorreu um erro ao executar os comandos do Git para adicionar o Plugin/Template à sua Stack.

Solução
Verificar a mensagem de erro retornada pelo Git. E também certificar que o Git está corretamente configurado em sua máquina.

stk add stages

‘stk add stages’ cannot be run in a empty directory!

Possível Causa O comando add stages foi executado em uma pasta vazia.

Solução
Executar o comando add stages dentro de uma pasta de um app.


“stk.yaml file not found”

Possível Causa O comando stk add stages foi executado em uma pasta que não é uma pasta de um app.

Solução
Executar o comando stk add stages dentro de uma pasta de um app.


“Invalid ‘stages’ option value. “

    "It must follow the format: "
    "<name>:<aws-account-number>:<aws-region>[,<name>:<aws-account-number>:<aws-region>]*."

Possível Causa Execução do comando stk add stages com parâmetro no formato errado

Solução
Executar o comando seguindo o formato correto, confira abaixo:

 stk add stages qa:12345:us-east-1,production:65432:us-east-2

stk apply plugin

‘name’ or ‘plugin-path’ options must be provided to execute ‘stk apply plugin’

Possível Causa O parâmetro com o nome ou o caminho do Plugin no comando apply plugin não foi informado.

Solução
Informar o nome de um Plugin ou path. Confira o exemplo abaixo:

 stk apply plugin <my-stack>/<my-plugin>

“Invalid plugin name, the expected format is ‘[/]’!"

Possível Causa O nome de Plugin informado não é válido para o comando stk apply plugin.

Solução
Informar um nome de Plugin válido de uma Stack já importada no padrão stk, veja o exemplo abaixo:

 apply plugin <stack-name>/<plugin-name>

“Plugin not found: /!"

Possível Causa O Plugin informado no stk apply plugin não foi encontrado em sua pasta de Stacks.

Solução
Checar se a Stack que você esta tentando usar foi corretamente importada e se o Plugin está na Stack.


“Plugin not found at: "

Possível Causa O caminho informado no stk apply plugin não possui um Plugin da StackSpot.

Solução
Conferir se o caminho informado é de um Plugin criado com o stk create plugin.


This plugin cannot be applied to an stack!

Possível Causa O tipo de Plugin não é válido para o projeto em que está sendo aplicado.

Solução
Conferir se você está usando um Plugin do tipo app para projetos criados com stk create app.


stk create app

"‘template’, ‘template-path’ or ‘stackfile’ options must be provided to execute ‘stk create app’."

Possível Causa
Um Template ou Stackfile não foram informados para a criação do app.

Solução

  1. Informar um Template através da flag --template.
  2. Informar um Stackfile a partir da flag --stackfile.

‘template’, ‘template-path’ or ‘stackfile’ options cannot be used together."

Possível Causa
Os comandos stk create app foi executado usando as flags --template e --stackfile em conjunto.

Solução
Usar somente uma flag no comando.


" is invalid, expected stack/template."

Possível Causa O comando stk create app foi criado com um Template inválido.

Solução
Usar um valor válido para a flag --template no padrão: /.


is not a valid name for a ‘stk create ’ in ‘’ command.

Possível Causa O nome do projeto utilizado no comando stk create app é inválido.

Solução
Utilizar um nome válido que tenha somente números, letras, hífen ("-") ou sublinhado ("_").


folder already exists and is not empty."

Possível Causa O comando stk create app foi executado em uma pasta que já possui uma outra pasta com o mesmo nome do projeto.

Solução
Utilizar outro nome para o projeto.


is not a valid git url.

Possível Causa A URL utilizada na opção --app não é uma URL Git.

Solução
Utilizar uma URL de um repositório Git que possua um app criado por meio do comando stk create app.


Stackfile {stackfile} doesn’t exist! Use stk list stackfile' to list available stackfiles.

Possível Causa O valor utilizado na opção --stackfile não corresponde a nenhum Stackfile importado.

Solução
Utilizar um dos Stackfiles disponíveis.

É possível executar o comando stk list stackfile para ver quais são os Stackfiles disponíveis.


“Invalid Stackfile: type is required."

Possível Causa
O Stackfile utilizado não possui o type definido.

Solução
Ajustar o Stackfile para ser do tipo: app.


“Invalid Stackfile: template is required."

Possível Causa
O Stackfile utilizado não possui um template definido.

Solução
Ajustar o Stackfile para ter o parâmetro de template.


“Invalid Stackfile: is not of type ‘app’."

Possível Causa
O Stackfile utilizado não possui o tipo correto para executar o comando.

Solução
Utilizar um stackfile de app para o comando stk create app.


Application template /<template_name> doesn’t exist! Use stk list template –app' to list available application templates.

Possível Causa
O Template utilizado na opção --template ou o Template definido no stackfile não existem na sua máquina.

Solução

  1. Importar a Stack que possui o Template.
  2. Utilizar um Templates disponíveis (Consulte quais com o comando stk list template).

Application template {template_path} doesn’t exist! Use ‘stk list template –app’ to list available application templates.

Possível Causa
O Template passado para a opção --template-path não existe ou não é um Template da StackSpot

Solução
Utilizar um caminho absoluto até um Template da StackSpot em sua máquina.


Application template in <template_path> is invalid: It’s not of type ‘app-template’!

Possível Causa
O Template utilizado na opção --template-path não é do tipo app-template.

Solução
Utilizar um template válido do tipo app-template na opção --template-path.


Stackfile / not found.

Possível Causa
O Stackfile informado no comando stk create app não foi encontrado.

Solução
Utilize o comando stk list stackfile para ver os Stackfiles disponíveis em sua organização.


Application template /<template_name> doesn’t exist! Use ‘stk list template –app’ to list available application templates!

Possível Causa
O Template utilizado na opção --template ou no stackfile não foi encontrado.

Solução
Utilizar um Template existente em sua máquina. Você pode ver os templates existentes executando o comando: stk list template --app.


Application template doesn’t exist! Use ‘stk list template –app’ to list available application templates.

Possível Causa
O Template passado para a opção --template-path não existe ou não é um Template da StackSpot.

Solução
Utilizar um caminho absoluto até um Template StackSpot em sua máquina.


Application template in <template_path> is invalid: It’s not of type ‘app-template’!

Possível Causa
O Template utilizado na opção --template-path não é do tipo app-template.

Solução
Utilizar um Template válido do tipo app-template na opção --template-path.


‘remote’ option is required when ‘NAME’ argument is not provided.

Possível Causa
Não foi informado um nome para o app e nem a opção --remote.

Solução
Informar o nome ou a opção --remote.


stk create plugin/stk create template

<plugin/template-name> folder already exists and is not empty.

Possível Causa
Os comandos stk apply plugin/stk apply template foram executados em uma pasta que já possui uma outra pasta com o mesmo nome do projeto.

Solução
Utilizar outro nome para o projeto.


–remote option can’t be used when ‘stk create plugin/template’ is run inside a stack folder.

Possível Causa
A opção --remote foi utilizada para criar um Plugin dentro de uma Stack já existente.

Solução
Não utilizar a opção --remote para criar a Stack. Se você quiser adicionar um Plugin/Template existente a uma Stack, utilize o comando stk add plugin ou stk add template.


‘types’ option must be a comma separated combination of ‘app’.

Possível Causa
Valor errado na opção --types.

Solução
Informar um valor correto para --types como app.


"‘types’ option must be a comma separated combination of ‘app-template’."

Possível Causa
Valor errado na opção --types.

Solução
Informar um valor correto para --types como app-template.


Stackfile is invalid.

Possível Causa
O valor do Stackfile passado para a opção --stackfile não é válido.

Solução
Verificar se o Stackfile é válido e se foi passado no padrão: /.


stk create stack

folder already exists!

Possível Causa
O comando stk create stack foi executado em uma pasta que já possui outra pasta com o mesmo nome da Stack.

Solução
Utilizar outro nome para a Stack ou utilizar outra pasta.

stk create stackfile

“File already exists in directory."

Possível Causa
O comando stk create stackfile foi executado em uma pasta que já possui um arquivo com o nome do stackfile.

Solução Utilizar outro nome para o stackfile.

stk delete plugin/stk delete template

<plugin/template> <plugin/template-name> not found."

Possível Causa
O Plugin/Template informado para ser apagado não foi encontrado.

Solução Informar um nome de um Plugin/Template existente dentro da Stack.


<plugin/template> <plugin/template-name> can’t be removed.

Possível Causa
Ocorreu algum erro inesperado durante a deleção.

Solução Verificar o detalhe do erro para mais informações.

stk delete stack

Stack not found."

Possível Causa
A Stack informada para deleção não foi encontrada.

Solução Informar o nome de uma Stack existente.

can’t be removed.

Possível Causa Ocorreu algum erro inesperado durante a deleção.

Solução Verificar o detalhe do erro para mais informações.



stk import stack

The provided url doesn’t contain a valid stack: Missing ‘stack.yaml’ file!

Possível Causa
A URL informada no comando stk import stack não tem uma Stack.

Solução Importar Stacks criadas a partir do comando stk create stack <stack-name>.


The provided url doesn’t contain a valid stack: Missing ‘name’ attribute in ‘stack.yaml’ file!

Possível Causa
Uso do comando stk import stack em um repositório que tem uma Stack inválida, e não tem o atributo name em seu stack.yaml.

Solução Corrigir os pontos da Stack que está sendo importada. Utilize o comando stk import stack para criar uma Stack válida.


already added to stk cli!

Possível Causa Tentativa de importar uma Stack que já existe em sua máquina.

Solução A Stack já está importada. Se você quiser atualizá-la, utilize o comando stk update stack <stack-name>.


is not a valid git url, or you don’t have permission to clone it.

Possível Causa A URL usada como argumento para stk import stack não é válida. Você também não tem permissão para acessá-la.

Solução Verificar se você tem as permissões necessárias no repositório e se a URL está correta.

stk list plugin/stk list template

Stack not found.\nUse ‘stk list stack’ to list available stacks.

Possível Causa
A Stack usada como parâmetro para o stk list plugin/template <stack-name> não existe em sua máquina.

Solução

  1. Importar Stacks com o comando stk import stack.
  2. Listar todas as Stacks usando o comando stk list stack.

Erro nos comandos list plugin e list template no Windows

Os comandos stk list plugin e stk list template criam um diretório .template na pasta onde são executados. Confira o exemplo abaixo:

$ stk list plugin
> no plugins found
Traceback (most recent call last):
  File "cli.py", line 78, in <module>
  File "cli.py", line 74, in main
  File "cli.py", line 67, in main
  File "click\core.py", line 1128, in __call__
  File "click\core.py", line 1053, in main
  File "click\core.py", line 1659, in invoke
  File "click\core.py", line 1628, in _process_result
  File "click\core.py", line 754, in invoke
  File "click\decorators.py", line 26, in new_func
  File "cli.py", line 62, in process_result
  File "metrics\send.py", line 23, in decorator
  File "plugin\list.py", line 46, in list_plugin
  File "plugin\list.py", line 66, in _get_plugins_by_type
  File "plugin\list.py", line 101, in _should_add_plugin
  File "plugin\list.py", line 114, in _is_app_type
KeyError: 'types'
[1576] Failed to execute script 'cli' due to unhandled exception!

Possível Causa
É possível que tenha ficado algum cache ou arquivo da versão anterior que foi desinstalada através de “Adicionar ou remover programas”. Por esse motivo, o novo instalador pode não ter limpado ou atualizado todos os arquivos.

Solução
Os Plugins só voltam a ser listados quando o update é forçado com as flags --clean e --force-update. Execute no seu terminal:

stk init --clean --force-update

stk list stackfile

Stack not found!

Possível Causa
A Stack informada como parâmetro para o stk list stackfile não foi encontrada.

Solução

  1. Utilizar o comando stk list stackfile sem argumentos para ver todas os Stackfiles disponíveis.
  2. Importar uma Stack usando o comando stk import stack.

stk update app

stk.yaml file not found

Possível Causa
A pasta onde o comando stk update app foi executado não possui o arquivo stk.yaml.

Solução Checar se a pasta foi criada com o comando stk create app.


stk update stack

Erro: <stack_name> stack not found.

Possível Causa
O nome da Stack utilizado no comando stk update stack não foi encontrado em sua máquina.

Solução Checar se a Stack que você está tentando atualizar foi importada pelo comando stk import stack.


stk login

is an invalid e-mail. Please provide a valid one.

Possível Causa O e-mail informado no login é inválido.

Solução Utilizar um e-mail válido no padrão user@organization.com.

Confira também