Comandos de Aplicação

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

Comando Descrição
stk create app Cria uma Aplicação a partir de um ou mais Plugins.
stk delete app Deleta uma Aplicação hospedada em um repositório remoto.
stk deploy app Executa o deploy da sua Aplicação.
stk destroy app Destrói a Aplicação de um ambiente.
stk list app Lista todos os aplicativos registrados em um Workspace.
stk register app Registra as informações de uma Aplicação em um Workspace.
stk register app-deploy Registra o deploy de uma Aplicação em um Workspace.
stk register app-destroy Registra a destruição de uma Aplicação em um Workspace.
stk rollback app Executa o rollback da sua Aplicação.
stk update app Atualiza o ID de uma Aplicação.
stk validate app Valida a estrutura de uma aplicação.

Comando	Descrição
stk create app	Cria uma Aplicação a partir de um ou mais Plugins.
stk delete app	Deleta uma Aplicação hospedada em um repositório remoto.
stk deploy app	Executa o deploy da sua Aplicação.
stk destroy app	Destrói a Aplicação de um ambiente.
stk list app	Lista todos os aplicativos registrados em um Workspace.
stk register app	Registra as informações de uma Aplicação em um Workspace.
stk register app-deploy	Registra o deploy de uma Aplicação em um Workspace.
stk register app-destroy	Registra a destruição de uma Aplicação em um Workspace.
stk rollback app	Executa o rollback da sua Aplicação.
stk update app	Atualiza o ID de uma Aplicação.
stk validate app	Valida a estrutura de uma aplicação.

stk create app

O comando stk create app cria uma Aplicação a partir de um Starter. A Aplicação é gerada com as capacidades dos Plugins utilizados no Starter, podendo ser aplicações com regras de negócio, infraestrutura ou alguma funcionalidade específica.

Aplicações criadas fora de um Workspace não podem ser registradas e implantadas na StackSpot.

Informação Adicional

A opção -o, --target permite definir um nome de pasta diferente para criar o conteúdo da Aplicação. Se a pasta não existir, ela será criada.

Se você não usar a opção -o ou --target, o nome da pasta do conteúdo da Aplicação será o mesmo que você deu ao criar a sua Aplicação.

Uso

stk create app [NOME_APP] --starter [STUDIO/STACK/STARTER]

Informação Adicional

O uso do stk create app com a flag e as opções --starter [ACCOUNT/STUDIO/STACK/STARTER] foi depreciado e será removido. Utilize a flag sem a informação de ACCOUNT como no exemplo a seguir:

Exemplo:

stk create app my-app-name --starter my-studio/my-stack/starter-name

Parâmetros

Opções	Descrição	Exemplo
`NOME_APP`	Define o nome da aplicação. Se o nome não for informado, é definido o nome do repositório do parâmetro `--remote`.	stk create app my-app-name
`-s, --starter`, `--starter studio-slug/stack-slug/starter-slug`	Define o Starter que vai aplicar o conjunto de Plugins na sua Aplicação. Você deve informar o nome do Starter e seus dados de origem como o Estúdio e a Stack. Você pode escolher a Stack no terminal de forma interativa. Você pode escolher a versão da Stack informando junto da flag `-s, --starter` a versão da Stack com `--starter studio-slug/stack-slug@[number-version]/starter-slug`. Você pode informar o caminho do arquivo de um Starter (`starter.yaml`) para criar a Aplicação com um Starter local.	stk create app my-app-name --starter my-studio/my-stack/starter-name Escolher a versão da Stack: stk create app my-app-name --starter my-stydio/my-stack@3.0.0/starter-name Escolher um Starter local: stk create app my-app-name --starter User/Documents/My-Local-Starters/starter-name.yaml
`-r`, `--remote <git-url>`	Define a URL do repositório remoto Git que é usada como origem do projeto. Se não for informado, o repositório remoto não será configurado e você deve fazer o processo manualmente.	stk create app my-app-name --remote my-git-repository-url
`-sgi`, `--skip-git-init`	Utilize essa opção para não inicializar um repositório Git durante a criação do app.	stk create app my-app-name --skip-git-init
`-d`, `--description`	Define uma descrição da sua Aplicação e seu propósito.	stk create app my-app-name --description "my app description" --starter my-studio/my-stack/starter-name
`-q, --non-interactive`	Não pergunta para o usuário os parâmetros de entrada e retorna um erro caso algum parâmetro obrigatório não for fornecido.	stk create app studio/stack/plugin --non-interactive
`-sp`, `--spec` [TEXTO]	Caminho para o arquivo de especificações que contém os dados de inputs e connections para cada Plugin aplicado.	stk create app my-app-name --spec /home/user/specs-folder/app.yaml
`-o`, `--target`	A opção `-o`, `--target` permite definir um nome de pasta diferente para criar o conteúdo da Aplicação. Se a pasta não existir, ela será criada. Se você não usar a opção `-o` ou `--target`, o nome da pasta do conteúdo da Aplicação será o mesmo que você deu ao criar a sua Aplicação.	stk create app my-app-name --starter my-studio/my-stack/starter-name --target home/user/Applications/my-app
`-er`, `--extra-repositories TEXT`	Forneça uma lista de repositórios adicionais para a sua Aplicação. Cada repositório deve ser um objeto JSON com a seguinte estrutura: `"[{"name":"repository_name", "description": "repository_description", "provider": "repository_provider", "url": "repository_url"}]"`	`stk create app my-example-app --starter studio/stack/starter-name --extra-repositories "[{"name":"my-example-app-repo", "description": "repository for test my apps", "provider": "github", "url": "https://github.com/my-organization-name/my-example-app-repo"}]"`
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk create app --help

stk delete app

O comando stk delete app apaga completamente uma Aplicação de um Workspace. Não ocorre o rollback da Aplicação, o registro da Aplicação na StackSpot e o conteúdo do repositório usado no deployment da Aplicação são deletados.

Uso

Se a sua Aplicação possui Plugins de Infraestrutura ativos com o deploy feito pelo self-hosted Runtime, o comando stk delete app é interrompido e você deve destruir a Infraestrutura da sua Aplicação primeiro. Caso não tenha usado o self-hosted Runtime e a sua Aplicação possuir deploys ativos em um ou mais ambientes, ocorrem as seguintes ações:

O comando valida se a destruição da Infraestrutura pode acontecer, caso seja possível, a Infraestrutura é destruída.
Somente quando a Infraestrutura de todos os ambientes for destruída com sucesso, ou seja, sem mais deploys ativos, as Connection Interfaces geradas pelos Plugins de Infraestrutura e os registros da Aplicação e Infraestrutura são deletados.

Caso contrário, sem nenhum deploy ativo, apenas o registro da Aplicação ou Infraestrutura é deletado.

Sintaxe

stk delete app --target [DIRETÓRIO DA APLICAÇÃO]

Exemplo:

Atenção!

O uso desse comando é exclusivo em pipelines, você precisa ter o STK CLI instalado em sua pipeline. Confira o exemplo a seguir do uso do comando dentro dos steps de uma pipeline:

Na pasta da aplicação, execute o comando informando os parâmetros a seguir:

.github/workflows/run-cli-commands.yml
steps: 
  - name: Delete App
    run: | 
      stk delete app --target ./Applications/my-app

Parâmetros

Opções	Descrição	Exemplo
`-o`, `--target`	Define o diretório alvo para deletar a Aplicação.	stk delete app --target ./Applications/my-app
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk delete app --help

stk deploy app

O comando stk deploy app executa o deploy da sua Aplicação em um Ambiente do 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 com o comando stk use workspace.

Uso

stk deploy app

Parâmetros

Opções	Descrição	Exemplo
`-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 app --version 1.0.0
`-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 app --env qa
`-b`, `--branch`	Nome da branch do Git que será usada no deployment. Opcional.	stk deploy app --branch app2-last-release
`--open-api-path`	Caminho para o arquivo Open API relativo à raiz do repositório Git. Opcional.	stk deploy app --open-api-path /home/user/my-app-folder
`-w, --watch`	Monitora o status do deploy automaticamente.	stk deploy app --env qa --watch
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk deploy app --help

stk destroy app

Atenção

Este recurso está temporariamente desativado. Durante esse período, se precisar destruir uma Aplicação, contate o nosso suporte.

O comando stk destroy app destrói uma Aplicação de um ambiente.

Uso

Sintaxe

stk destroy app --env<ENV_NAME>

Exemplo

Você deve acessar a pasta da Aplicação que deseja destruir e executar o comando:

cd my-app-folder
stk destroy app --env prod

Parâmetros

Opções	Descrição	Exemplo
`-e, --env`	Ambiente que foi feito o deploy da Aplicação. Obrigatório.	stk destroy app --env prod
`-w, --watch`	Monitora o status da destruição da aplicação automaticamente.	stk destroy app --env prod --watch
`-q`, `--non-interactive`	Não pergunta para o usuário os parâmetros de entrada e retorna um erro caso algum parâmetro obrigatório não for fornecido.	stk destroy app --env prod --non-interactive
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk destroy app --help

stk list app

O comando stk list app exibe no terminal uma lista com todas as aplicações registradas no 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 app

Parâmetros

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

stk register app

O comando stk register app faz o registro de uma Aplicação no 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

Execute, dentro da pasta da Aplicação, o comando:

stk register app

Parâmetros

Opções	Descrição	Exemplo
`-r`, `--remote`	Define a URL do repositório remoto Git que é usado para hospedar a sua aplicação. Se não for informado, o repositório remoto não será configurado e você deve fazer o processo manualmente.	stk register app --remote url
`-bb`, `--base-branch`	Nome da branch base do repositório da sua aplicação	stk register app --base-branch my-app-release-branch
`-er`, `--extra-repositories TEXT`	Forneça uma lista de repositórios adicionais para a sua Aplicação. Cada repositório deve ser um objeto JSON com a seguinte estrutura: `"[{"name":"repository_name", "description": "repository_description", "provider": "repository_provider", "url": "repository_url"}]"`	`stk register app --base-branch my-app-release-branch --extra-repositories "[{"name":"my-example-app-repo", "description": "repository for test my apps", "provider": "github", "url": "https://github.com/my-organization-name/my-example-app-repo"}]"`
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk register app --help

stk register app-deploy

O comando stk register deploy faz o registro do deploy de uma Aplicação no seu Workspace para Aplicações que não utilizam StackSpot Runtimes.

Uso

Atenção!

O uso desse comando é exclusivo em pipelines, você precisa ter o STK CLI instalado em sua pipeline. Confira o exemplo a seguir do uso do comando dentro dos steps de uma pipeline:

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.

.github/workflows/run-cli-commands.yml
steps: 
  - name: Authenticate StackSpot
    run: |
      stk login --client-id ${{ secrets.CLIENT_ID }} --client-key ${{ secrets.CLIENT_KEY }} --realm ${{ secrets.CLIENT_REALM }}

  - name: Use your Workspace
    run: |
      stk use workspace my-workspace-name    

  - name: Register App Deployment
    run: |
      stk register app-deploy --env prod --status success --version 1.0.0 --target ./Apps/my-app

Execute, dentro da pasta da Aplicação, o comando:

stk register app-deploy --env prod --status success --version 1.0.0 --target ./Apps/my-app

Parâmetros

Opções	Descrição	Exemplo
`-e`, `--env`	Nome do ambiente para registrar o deploy da Aplicação.	stk register app-deploy --env dev
`-s`, `--status [error, success]`	Preencha o status do deploy da Aplicação que deve ser registrado na StackSpot. Os valores aceitos são `error` (para erros no deploy) e `success` (para sucesso no deploy).	stk register app-deploy --status success
`-v`, `--version`	Informe a versão da Aplicação do deploy que você quer registrar na StackSpot.	stk register app-deploy --env prod --status success --version 1.0.0
`-o`, `--target`	Informe o diretório que ocorre o deploy da Aplicação para ser registrada.	stk register app-deploy --env prod --status success --version 1.0.0 --target ./Apps/my-app
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk register app-deploy --help

stk register app-destroy

O comando stk register destroy faz o registro do destroy de uma Aplicação no seu Workspace para Aplicações que não utilizam StackSpot Runtimes.

Uso

Atenção!

O uso desse comando é exclusivo em pipelines, você precisa ter o STK CLI instalado em sua pipeline. Confira o exemplo a seguir do uso do comando dentro dos steps de uma pipeline:

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.

.github/workflows/run-cli-commands.yml
steps: 
  - name: Authenticate StackSpot
    run: |
      stk login --client-id ${{ secrets.CLIENT_ID }} --client-key ${{ secrets.CLIENT_KEY }} --realm ${{ secrets.CLIENT_REALM }}

  - name: Use your Workspace
    run: |
      stk use workspace my-workspace-name    

  - name: Register App Deployment
    run: |
      stk register app-destroy --env prod --status success --target ./Apps/my-app

Execute, dentro da pasta da Aplicação, o comando:

stk register app-destroy --env dev --status fail --target ./Apps/my-app

Parâmetros

Opções	Descrição	Exemplo
`-e`, `--env`	Nome do ambiente para registrar o destroy da Aplicação.	stk register app-destroy --env dev
`-s`, `--status [success, failed]`	Preencha o status do destroy da Aplicação que deve ser registrado na StackSpot. Os valores aceitos são `success` (para sucesso do deploy) e `failed` (para falhas do deploy).	stk register app-destroy --status success
`-o`, `--target`	Informe o diretório que ocorre o destroy da Aplicação para ser registrada.	stk register app-destroy --env prod --status success --target ./Apps/my-app
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk register app-destroy --help

stk rollback app

O comando stk rollback app executa o rollback da sua aplicação.

Uso

Sintaxe

stk rollback app --version<VERSION> --env<ENV_NAME>

Exemplo

stk rollback app --version 1.2.0 --env prod

Parâmetros

Opções	Descrição	Exemplo
`-v, --version`	Versão da tag utilizada no deploy, o padrão deve seguir o versionamento semântico.	stk rollback app --version 1.2.0 --env prod
`-e, --env`	Ambiente que será usado para executar o rollback. Você pode consultar os ambientes disponíveis utilizando o comando `stk list env`	stk rollback app --version 1.2.0 --env prod
`-w, --watch`	Monitora o status do rollback da aplicação automaticamente.	stk rollback app --version 1.2.0 --env prod --watch
`-q`, `--non-interactive`	Não pergunta para o usuário os parâmetros de entrada e retorna um erro caso algum parâmetro obrigatório não for fornecido.	stk rollback app --version 1.0.0 --env prod --non-interactive
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk rollback app --help

stk update app

O comando stk update app atualiza as informações de uma Aplicação na StackSpot.

Voce pode atualizar as seguintes informações da Aplicação:

name;
description;
repository URL;
default branch.

Uso

Sintaxe

stk update app [OPTIONS]

Exemplo

stk update app --description "Updated Application description"

Informação Adicional

Os Dados armazenados nos metadados da aplicação serão sincronizados com a API.

Parâmetros

Opções	Descrição	Exemplo
`-n`, `--name TEXTO`	Ele atualiza o nome da Aplicação	stk update app --name app-renamed
`-d`, `--description TEXTO`	Atualiza a descrição da Aplicação.	stk update app --description "minha nova descrição do aplicativo"
`-r`, `--repo-url TEXTO`	Adiciona a URL do repositório Git da Aplicação.	stk update app --repo-url https://github.com/my-org/my-new-app-repository
`-b`,`--repo-base-branch TEXTO`	Atualiza a Git branch base da Aplicação.	stk update app --name "update/app-branch-name"
`-q`, `--non-interactive`	Ative o modo não interativo e não solicite nenhum parâmetro faltante.	stk update app --non-interactive
`-er`, `--extra-repositories TEXT`	Forneça uma lista de repositórios adicionais para a sua Aplicação. Cada repositório deve ser um objeto JSON com a seguinte estrutura: `"[{"name":"repository_name", "description": "repository_description", "provider": "repository_provider", "url": "repository_url"}]"`	`stk update app --name app-renamed --extra-repositories "[{"name":"my-example-app-repo", "description": "repository for test my apps", "provider": "github", "url": "https://github.com/my-organization-name/my-example-app-repo"}]"`
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk update app --help

stk validate app

O comando stk validate app valida a estrutura de uma aplicação. Para validar uma aplicação, execute o comando dentro da pasta da aplicação.

O comando irá:

Validar a estrutura da sua aplicação;
Remover pastas vazias;
Ignorar arquivos e pastas que você não deseja ao finalizar o desenvolvimento da sua aplicação.

informação

Os arquivos ignorados no arquivo .gitignore não serão validados pelo comando.

Ao final da execução do comando, ele apresenta uma mensagem com as inconsistências e o resultado da validação.

Uso

stk validate app

Parâmetros

Opções	Descrição	Exemplo
`-v`, `--verbose`	Opção para listar os detalhes de todos os itens analisados, validados e ignorados na sua aplicação.	stk validate app --verbose
`-h`, `--help`	Exibe a ajuda do comando e sai.	stk validate app --help