Comandos de Starter

Nesta seção, você encontra instruções detalhadas sobre os comandos para gerenciar Starters utilizando o STK CLI.

Comando	Descrição
stk create starter	Cria um Starter em uma Stack com o STK CLI.
stk list starter	Lista todos os Starters em um Workspace.
stk validate starter	Valida a estrutura de um Starter antes de publicá-lo em uma Stack.

stk create starter

O comando stk create starter cria a estrutura básica de um Starter. Para saber mais sobre a estrutura do Starter, confira como criar o Starterno STK CLI.

Informação adicional

A opção -o ou --target permite definir um nome de pasta diferente para criar o conteúdo do Starter. Se a pasta não existir, ela será criada automaticamente. Se você não usar a opção -o ou --target, o nome da pasta do conteúdo do Starter será o mesmo nome informado para o Starter.

Uso

Sintaxe

stk create starter [NOME]

Exemplo

stk create starter my-starter-name

Parâmetros

| Opção |Descrição | Exemplo | |------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| | -d, --description | Descrição doStarter. |

stk create startermy-starter-name --description "My Starter description"

| | -r, --remote | URL Git definida como repositório remoto (origin). Se utilizada, o campo NAME do Starter será definido pelo nome dorepositório Git. |

stk create starter my-starter-name --remote https://github.com/MyGitHubOrg/my-repository

| | -sgi, --skip-git-init | Não inicializa um repositório Git ao criar oStarter. |

stk create starter my-starte-name --skip-git-init

| | -q, --non-interactive | Executa o comando sem perguntas interativas. Retorna erro se faltar algum input obrigatório. |

stk create starter my-starter-name --non-interactive

| | -o, --target | Define uma pasta específica para criar o conteúdo do Starter. Se a pasta não existir, ela será criada. Se você não usar essaopção, o nome da pasta será o mesmo do Starter. |

stk create starter my-starter-name --description "My Starter description" --target home/userdocuments/my-stacks

| | -t, --type | Tipo do Starter. Valor aceito atualmente:app. |

stk create starter --type app

| | -h, --help | Exibe a ajuda do comando. |

stk create starter --help

stk list starter

O comando stk list starter exibe no terminal os Starters disponíveis. Você pode:

Listar os Starters de um Workspace disponíveis para a sua conta. Para isso, acesse primeiro o Workspace com o comando stk use workspace.
Listar Starters fora de um Workspace, informando o Estúdio e a Stack após executar o comando.
Você visualiza o nome, tipo e descrição do Starter. O comando também sinaliza se algum Starter está depreciado com a tag 'deprecated'.

Uso

stk list starter

Parâmetros

Opção	Descrição	Exemplo
`-stu, --studio`	Filtra e exibe a lista de Starters por Estúdio.	stk list starter --studio studio-name
`-sta, --stack`	Filtra e exibe a lista de Starters por Stack.	stk list starter --stack stack-name
`-t, --type [app/infra]`	Filtra os Starters por tipo. Valores aceitos: `app` ou `infra`.	stk list starter --type infra
`-h, --help`	Exibe a ajuda do comando.	stk list starter --help

stk validate starter

O comando stk validate starter valida a estrutura do seu Starter e seus componentes. Os arquivos ignorados em seu .gitignore não serão validados.

Uso

Sintaxe

stk validate starter

Exemplo

No diretório do Starter, execute:

stk validate starter

Parâmetros

Opção	Descrição	Exemplo
`-v, --verbose`	Apresenta a validação com mais detalhes.	stk validate starter --verbose
`-h, --help`	Exibe a ajuda do comando.	stk validate starter --help