Comandos Gerais

Nesta seção, você encontra a lista de comandos de uso geral.

Comando	Descrição
stk --help	A flag `--help` mostra mais informações sobre os comandos e seus parâmetros.
stk --version	Mostra a versão atual instalada.
stk ai	Inicia o Assistente de Inteligência Artificial StackSpot.
stk configure connection	Edita as configurações da Connection exigida ao aplicar um Plugin de app ou infra.
stk config locale	Configura o idioma exibido no terminal do STK CLI.
stk create extension	Cria uma Extensão para o StackSpot EDP.
stk deploy plan	Gera um arquivo de manifesto usado para planejar a implantação de uma Aplicação ou Infraestrutura.
stk deploy status	Monitora o status do deploy atual em execução.
stk destroy status	Apresenta o status do destroy usando seu ID.
stk diff state	Exibe um diff do deployment de uma Aplicação ou Infraestrutura entre dois ambientes.
stk init	Inicialização e configuração da ferramenta STK CLI no seu ambiente.
stk list env	Lista todos os ambientes disponíveis dentro de um Workspace.
stk list studio	Lista todos os Studios disponíveis em sua conta StackSpot.
stk login	Realiza o login em uma conta StackSpot.
stk logout	Realiza o logout da conta StackSpot.
stk notify	Comando para enviar uma notificação de Deploy para a StackSpot.
stk publish api	Publica sua API na StackSpot.
stk publish extension	Publica a sua Extensão no StackSpot EDP.
stk rollback status	Apresenta o status do rollback usando seu ID.
stk show me	Apresenta no terminal as informações do seu usuário da conta StackSpot.
stk update api-definition	Atualiza as definições de uma API.
stk update doc	Atualiza a documentação de um Plugin, Stack ou Action.
stk upgrade	Atualiza para uma nova versão da CLI.

stk --help

O STK CLI possui a opção --help para mostrar mais informações sobre os comandos e seus parâmetros.

Escreva no seu terminal o comando que precisa saber mais informações e logo depois adicione --help.

Uso

Sintaxe
stk init help
stk create help
stk list help

<stk command> --help

stk init --help

stk create --help

stk list --help

stk --version

Exibe no terminal a versão atual do STK CLI que está instalada.

Uso

stk --version

Parâmetros

Opções Descrição Exemplo

Opções	Descrição	Exemplo
`--version` ou `-v`	Apresenta no terminal a versão atual do STK CLI instalada em sua máquina.	stk --version ou stk -v

--version ou -v

Apresenta no terminal a versão atual do STK CLI instalada em sua máquina.

stk --version

stk -v

stk ai

O comando stk ai inicia o Assistente de Inteligência Artificial da StackSpot em seu terminal.

Uso

Execute o comando para inicializar o assistente:

stk ai

Em seguida, faça perguntas no prompt para o assistente.

Para acessar a ferramenta de análise de código. Insira 'code' no seu prompt e cole o código fonte para ser revisado;
Insira 'exit' ou 'Ctrl+c' para encerrar sua sessão.

Parâmetros

Opção	Descrição	Exemplo
`-oc`, `--only-code`	Use está opção para gerar somente o código sem explicações do agente.	stk ai code [your prompt here] --only-code
`-o`, `--output`	Define um arquivo para gravar o código de saída do prompt.	stk ai code [your prompt here] --output file.txt
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk ai --help

stk configure connection

Atenção!

O comando stk configure connection-interface vai ser depreciado e não será mais utilizado, ele foi atualizado para stk configure connection .

O comando stk configure connection possibilita editar as configurações da Connection exigida ao aplicar um Plugin de app ou infra.

A Connection requerida já deve estar cadastrada.

Uso

Sintaxe

stk configure connection [OPÇÕES] [CONNECTION-ALIAS]

Você pode configurar as Connection que aparecem na lista do Portal.

Exemplo

stk configure connection-interface <connection-alias> --plugin <studio>/<stack>/<plugin>@<version> --new-value <connection-to-select>

Parâmetros

Opções Descrição Exemplo

Opções	Descrição	Exemplo
`-a, --alias`	Alias do Plugin que será configurado.	stk configure connection my-conn-alias1 --alias my-plugin-alias -nv my-conn-alias2
`-nv, --new-value`	Informa o nome da nova Connection.	stk configure connection my-conn-alias1 --alias my-plugin-alias --new-value my-conn-alias2
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk configure connection --help

-a, --alias

Alias do Plugin que será configurado.

stk configure connection my-conn-alias1 --alias my-plugin-alias -nv my-conn-alias2

-nv, --new-value

Informa o nome da nova Connection.

stk configure connection my-conn-alias1 --alias my-plugin-alias --new-value my-conn-alias2

-h, --help

Exibe a ajuda do comando e sai.

stk configure connection --help

stk config locale

O comando stk config locale faz a alteração do idioma exibido no terminal do STK CLI. As opções de idioma são en_US e pt_BR.

Uso

Sintaxe

stk config locale [OPTIONS]

Exemplo

stk config locale

No terminal, selecione entre Português ou English.

Parâmetros

Opções	Descrição	Exemplo
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk config locale --help

stk create extension

O comando stk create extension cria a estrutura de uma Extensão customizável para a StackSpot EDP com o STK CLI. Você deve adicionar o código da sua Extensão nessa estrutura.

Uso

Para criar uma extensão, você precisa executar o comando stk create extension e informar os dados da sua Extensão:

Nome da Extensão;
Descrição para a Extensão;
Nível em que sua Extensão será visível. As opções disponívels são os níveis de Organização ou Workspace;
Caminho da pasta onde você vai adicionar o código da sua extensão.

Sintaxe

stk create extension [OPÇÕES] [NOME]

Exemplo

stk create extension dashboard-extension --level workspace

Parâmetros

Opções	Descrição	Exemplo
`-r`, `--remote GIT-REMOTE-URL`	URL de um repositório Git como origem do repositório de uma Extensão. Obrigatório quando o valor `NOME` não é informado na Extensão, neste caso o valor do `NOME` será definido como o nome do repositório Git informado.	stk create extension --remote https://github.com/my-gh-organization/my-extension-repository
`-sgi`, `--skip-git-init`	Não inicia um repositório Git na pasta da Extensão.	stk create extension my-extension-name --skip-git-init
`-d`, `--description`	Descrição que explique o propósito e uso da sua Extensão.	stk create extension my-extension-name --description "Creating my first StackSpot EDP Extension."
`-l`, `--level`	Configura os níveis em que a Extensão ficará disponível. Os níveis aceitos são: `organização` ou `workspace`.	stk create extension my-extension-name --description "Creating my first StackSpot EDP Extension." --level workspace
`-p`, `--path`	Caminho relativo para a pasta de distribuição. A pasta de distribuição (`dist`) é a pasta que contém o código otimizado e pronto da sua Extensão para ser usado em produção. A pasta de distribuição é gerada pelo processo de construção do projeto (`project build`).	stk create extension my-extension-name --description "Creating my first StackSpot EDP Extension." --level workspace --path /project/dist
`-q`, `--non-interactive`	Não pergunta ao usuário os parâmetros de entrada, retornando um erro caso algum parâmetro obrigatório não tenha sido fornecido.	stk create extension my-extension-name --description "Creating my first StackSpot EDP Extension." --level workspace --non-interactive
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk create extension --help

stk deploy plan

O comando stk deploy plan gera um arquivo de manifesto (manifest.yaml) usado para planejar a implantação de uma Aplicação ou Infraestrutura.

Antes de executar o comando você deve:

Fazer o login na sua Conta com o comando stk login.
Estar com um Workspace ativo, acesse um Workspace com o comando stk use workspace.

Uso

stk deploy plan --env env_name

Parâmetros

Opções	Descrição	Exemplo
`-e`, `--env`	Define o nome do Ambiente que será usado para executar o deploy da Aplicação. Consulte os Ambientes disponíveis em seu Workspace através do comando stk list env.	stk deploy plan --env qa
`-o`, `--target`	Caminho onde o arquivo manifest.yaml será gerado. Por padrão será gerado na pasta atual.	stk deploy plan --env qa --target /home/user/app
`-v`, `--version`	Define a versão da tag de deploy. Você deve usar o padrão de versionamento semântico. Exemplo: "1.0.0"	stk deploy plan --version 1.0.0
`-b`, `--branch`	Nome da branch do Git que será usada no deployment. Opcional.	stk deploy plan --branch app2-last-release
`-r`, `--repo`	URL do repositório que será validado com o repositório registrado no manifesto da Aplicação/Infraestrutura.	stk deploy plan --env development --repo https://github.com/my-org-name/org-repo-name
`--open-api-path`	Caminho para o arquivo Open API relativo à raiz do repositório Git. Opcional.	stk deploy plan --open-api-path API/my-app-folder
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk deploy plan --help

stk deploy status

O comando stk deploy status monitora e exibe o status do deploy da sua aplicação ou infraestrutrua em execução.

Antes de executar o comando você deve:

Fazer o login na sua Conta com o comando stk login.
Estar com um Workspace ativo, acesse um Workspace com o comando stk use workspace.

Uso

stk deploy status [APP-OR-INFRA_ID]

informação

O ID do deploy fica localizado arquivo stk.yaml da aplicação ou infraestrutura, dentro do campo spec: nos atributos app-id ou infra-id.

Parâmetros

Opções Descrição Exemplo

Opções	Descrição	Exemplo
`-w`, `--watch`	Monitora e exibe no terminal o status do deploy automaticamente.	stk deploy status STATUS_ID --watch
`-r, --report`	Gera um relatório de status com o tipo de arquivo informado. Os tipos de arquivo suportados são: `json` ou `md`.	stk deploy status STATUS_ID --watch --report json ou stk deploy status STATUS_ID --watch --report md
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk deploy status --help

-w, --watch

Monitora e exibe no terminal o status do deploy automaticamente.

stk deploy status STATUS_ID --watch

-r, --report

Gera um relatório de status com o tipo de arquivo informado. Os tipos de arquivo suportados são: json ou md.

stk deploy status STATUS_ID --watch --report json

stk deploy status STATUS_ID --watch --report md

-h, --help

Exibe a ajuda do comando e sai.

stk deploy status --help

stk destroy status

O comando stk destroy status apresenta o status da destruição de uma Aplicação ou Infraestrutura. Você deve usar o ID retornado pelos comandos stk destroy app e stk destroy infra.

Uso

Sintaxe

stk destroy status <DESTROY_ID>

Exemplo

stk destroy status DESTROY_ID --watch --report

Parâmetros

Opções Descrição Exemplo

Opções	Descrição	Exemplo
`-w, --watch`	Monitora o status da destruição automaticamente.	stk destroy status DESTROY_ID --watch
`-r, --report`	Gera um relatório de status com o tipo de arquivo informado. Os tipos de arquivo suportados são: `json` ou `md`.	stk destroy status DESTROY_ID --watch --report json ou stk destroy status DESTROY_ID --watch --report md
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk destroy status --help

-w, --watch

Monitora o status da destruição automaticamente.

stk destroy status DESTROY_ID --watch

-r, --report

Gera um relatório de status com o tipo de arquivo informado. Os tipos de arquivo suportados são: json ou md.

stk destroy status DESTROY_ID --watch --report json

stk destroy status DESTROY_ID --watch --report md

-h, --help

Exibe a ajuda do comando e sai.

stk destroy status --help

stk diff state

O comando stk diff state compara o status do deployment de uma Aplicação ou Infraestrutura entre um ambiente alvo e um ambiente origem e exibe no terminal as diferenças que existem entre os ambientes.

Uso

Ative o uso de um Workspace com o comando stk use workspace.
Execute o comando dentro da pasta da Aplicação ou Infraestrutura, em seguida informe o(s) nome(s) do(s) ambiente(s) que você deseja consultar.
Ao desabilitar o highlight do texto da comparação exibida no terminal, os seguintes símbolos são apresentados das linhas alteradas:

---: Representa um trecho removido.
+++: Representa um trecho adicionado.
^^^: Representa um trecho alterado.

Sintaxe

Por padrão, o comando compara as diferenças da Aplicação ou Infraestrutura especificadas em TARGET_ENV com aquelas do seu ambiente local:

stk diff state [TARGET_ENV]

Para informar o nome do ambiente de origem que você deseja, use a opção --origin-env.

stk diff state [TARGET_ENV] --origin-env [ORIGIN_ENV]

Exemplo

Comparação do estado de uma Aplicação local com a Aplicação do ambiente de produção (production):

stk diff state production

Comparação do estado de uma Aplicação do ambiente de desenvolvimento (development) com a Aplicação no ambiente de produção (production):

stk diff state production --origin-env development

Para desabilitar o destaque (highlight) exibido no terminal, use a opção --highlight-disable:

stk diff state development --highlight-disable

Parâmetros

Opções	Descrição	Exemplo
`-o, --origin-env`	Define o ambiente utilizado no deployment da Aplicação ou Infraestrutura. Você deve informar o nome do ambiente desejado. O valor padrão é ‘local’ para comparar a Aplicação ou Infraestrutura da pasta local atual.	stk diff state development --origin-env production
`--hd, --highlight-disable`	Desabilita o destaque (highlight) das diferenças exibidas no terminal.	stk diff state development --highlight-disable
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk diff state --help

stk init

O comando stk init é utilizado na inicialização e configuração da ferramenta STK CLI no seu ambiente. O comando mostra uma lista de todos os parâmetros disponíveis, além de permitir configurar o proxy e desabilitar os certificados.

Os usuários com a VPN privada devem configurar os parâmetros manualmente.

Parâmetros

Confira as opções disponíveis no comando:

Opções	Descrição	Exemplo
`-k ou --disable-ssl-verify`	Desabilita a verificação de certificados SSL. É usado quando o proxy nos ambientes de VPN privada retornam certificados inválidos para o Github.	stk init --disable-ssl-verify
`-p ou --proxy <host>:<port>`	Configura um proxy para realizar as conexões HTTP.	stk init --proxy proxy.mycorp:8080
`-c ou --clean`	Limpa as configurações feitas anteriormente. É usada para remover configurações padrão.	stk init --clean
`-e ou --proxy-exclusions <url-proxy1>,<url-proxy-2>`	Define a lista de URLs, separadas por vírgula, que não devem se conectar via proxy configurado.	stk init --proxy-exclusions proxy.mycorp1.com, proxy2.mycorp.com, proxyn.mycorp.com
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk init --help

stk list env

O comando stk list env lista todos os ambientes disponíveis para a sua Conta.

Os ambientes devem ser configurados no portal da StackSpot.
Para saber como configurar um ambiente acesse o guia para configurar o seu Workspace.

Antes de executar o comando você deve:

Fazer o login na sua Conta com o comando stk login.
Estar com um Workspace ativo, acesse um Workspace com o comando stk use workspace.

Uso

stk list env

Parâmetros

Opções	Descrição	Exemplo
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk list env --help

stk list studio

O comando stk list studio lista no terminal os Studios disponíveis em sua conta StackSpot.

Uso

stk list studio

Parâmetros

Opções	Descrição	Exemplo
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk list studio --help

O comando stk login realiza o login em uma conta StackSpot. Você precisa informar o e-mail da sua conta StackSpot. A partir disso, o comando abre o seu navegador e pede pelo preenchimento de seus dados e a confirmação de acessos para gerar uma sessão.

Uso

stk login [EMAIL]

Parâmetros

Opções	Descrição	Exemplo
`EMAIL`	E-mail utilizado para fazer o login na conta StackSpot.	stk login mystackspot-account@email.com
`-id`, `--client-id`	ID do cliente gerado no site da StackSpot.	stk login mystackspot-account@email.com -id [ID value] -key [Client Key value]
`-key`, `--client-key`	Chave do cliente gerada no site da StackSpot.	stk login mystackspot-account@email.com -id [ID value] -key [Client Key value]
`-r`, `--realm`	Domínio da organização StackSpot do cliente.	stk login mystackspot-account@email.com -id [ID value] -key [Client Key value] -r [Client realm name]
`-a`, `--account-type`	Define o tipo de conta para o login. As opções disponíveis são: `enterprise` ou `personal`.	stk login mystackspot-account@email.com --account-type personal
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk login --help

stk logout

O comando stk logout encerra a sessão de uma conta da StackSpot logada. Ele inativa a sessão criada por meio do comando stk login.

Uso

stk logout

stk notify

O comando stk notify deve ser executado após o uso dos comandos de deploy, como o (deploy de aplicação ou deploy de infraestrutura), quando o deploy não é executado pelo StackSpot Runtimes.

O comando irá notificar a StackSpot que um deploy foi executado.

Uso

stk notify

stk publish api

O comando stk publish api atualiza sua API na StackSpot no estado "Draft" para "Published". Publica a sua API a tornando visível para uso.

Uso

Sintaxe

stk publish api [API_ID]

Exemplo

stk publish api AJDt2A5pe2T

Parâmetros

Opções	Descrição	Exemplo
`-e, --env`	Nome do ambiente que será atualizado.	stk publish api AJDt2A5pe2T --env prod
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk publish api --help

stk publish extension

O comando stk publish extension publica uma Extensão da StackSpot EDP.

Uso

O uso do comando é indicado para realizar a publicação de Extensões do EDP via pipelines.

Sintaxe

stk publish extension [OPÇÕES]

Exemplo

stk publish extension --activate  my-studio

Parâmetros

Opções	Descrição	Exemplo
`-a, --activate`	Nome do Estúdio que será vinculado a Extensão.	stk publish extension --activate studio-slug-name
`-q, --skip-confirmation`	Ignora o aviso de ativação da Extensão.	stk publish extension --activate studio-slug-name --skip-confirmation
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk publish extension --help

stk rollback status

O comando stk rollback status apresenta o status do rollback de uma Aplicação ou Infraestrutura. Você deve usar o ID retornado pelos comandos stk rollback app e stk rollback infra.

Uso

Sintaxe

stk rollback status <ROLLBACK_ID> --wath --report <report-format>

Exemplo

stk rollback status ROLLBACK_ID --watch --report json

Parâmetros

Opções Descrição Exemplo

Opções	Descrição	Exemplo
`-w, --watch`	Monitora o status do rollback automaticamente.	stk rollback status ROLLBACK_ID --watch
`-r, --report`	Gera um relatório de status com o tipo de arquivo informado. Os tipos de arquivo suportados são: `json` ou `md`.	stk rollback status ROLLBACK_ID --watch --report json ou stk rollback status ROLLBACK_ID --watch --report md
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk rollback status --help

-w, --watch

Monitora o status do rollback automaticamente.

stk rollback status ROLLBACK_ID --watch

-r, --report

Gera um relatório de status com o tipo de arquivo informado. Os tipos de arquivo suportados são: json ou md.

stk rollback status ROLLBACK_ID --watch --report json

stk rollback status ROLLBACK_ID --watch --report md

-h, --help

Exibe a ajuda do comando e sai.

stk rollback status --help

stk show me

O comando stk show me apresenta os detalhes do seu usuário da conta StackSpot ativa no STK CLI.

Uso

Sintaxe

stk show me

Exemplo

Após efetuar o login, execute o comando para obter os seguintes dados da sua conta:

stk show me

Confira o exemplo a seguir:

Name: nome de usuário cadastrado. Exemplo: John Doe.
Username: nome de usuário e/ ou email cadastrado. Exemplo: john.doe@github.com.
Email: endereço de email da conta. Exemplo: john.doe@github.com.
Account: nome da sua conta StackSpot. Exemplo: John Doe.
Account Slug: slug da sua conta. Exemplo john-doe.
Account Type: o tipo da sua conta. Exemplo: enterprise.
Realm: domínio da sua conta StackSpot. Exemplo: github.
Start session: data de início da sua sessão. Exemplo: 2024-01-18 10:24:40.
Expiration session: data de expiração da sessão. Exemplo: 2024-01-18 11:24:40.
Expiration refresh: data de renovação da sessão. Exemplo: 2024-01-18 19:24:40.

Parâmetros

Opções	Descrição	Exemplo
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk show me --help

stk update api-definition

O comando stk update api-definition atualiza a especificação OpenAPI da sua API publicada na StackSpot.

Uso

Sintaxe

stk update api-definition [API_ID]

Exemplo

stk update api-definition AJDt2A5pe2T

Parâmetros

Opções	Descrição	Exemplo
`-e, --env`	Nome do ambiente da API que será atualizado.	stk update api-definition AJDt2A5pe2T --env prod
`-c, --contract`	Caminho para o arquivo da especificação OpenAPI.	stk update api-definition AJDt2A5pe2T --contract home/user/my-apis/openapi-specs/api-spec.yaml
`-g, --gateway-url`	Define URL base da API.	stk update api-definition AJDt2A5pe2T --env hom --gateway-url
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk update api-definition --help

stk update doc

O comando stk update doc atualiza a documentação de uma Action, Stack ou Plugin.

Uso

Sintaxe

stk update doc [STUDIO-SLUG]

Dentro da pasta da sua Stack, Plugin ou Action, execute o comando:

Exemplo

stk update doc

Parâmetros

Opções	Descrição	Exemplo
`-s, --studio`	O nome do Estúdio que terá a Stack, Plugin ou Action atualizados.	stk update doc --studio my-studio-slug
`-v, --verbose`	Apresenta a atualização da documentação com mais detalhes.	stk update doc --verbose
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk update doc --help

stk upgrade

O comando stk upgrade atualiza a versão do STK CLI quando há uma nova disponível.

Uso

Para atualizar o STK CLI, execute no terminal o comando stk upgrade:

stk upgrade

Se houver uma nova versão disponível, a seguinte mensagem será exibida no terminal:

Your STK CLI version 4.0.0 is outdated. The new version 4.1.0 is available.
To upgrade run the command: 'stk upgrade'.

Parâmetros

Opções	Descrição	Exemplo
`--force`	Força o STK CLI a fazer o upgrade para uma nova versão principal	stk upgrade --force
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk upgrade --help

Uma nova versão principal, também conhecida como versão major, traz mudanças em relação à versão anterior. Essas mudanças causam incompatibilidade entre as versões e impossibilita que você retorne para a versão anterior.

Se uma versão major está disponível, ao fazer a atualização, o STK CLI apresenta um aviso de incompatibilidade e disponibiliza o parâmetro --force para que você atualize a versão.