Starter Commands
In this section, you will learn more about the Starter's commands.
Command Description stk create starter Create a Stack's Starter with the STK CLI. stk list starter Lists all Starters within a Workspace. stk validate starter Validate the Starter structure to be published within the Stack.
stk create starter
The stk create starter command creates a basic Starter structure. See how to create Starter in STK CLI.
The -o, --target option allows you to define a different folder name to create the Starter content. If the folder does not exist, it will be created.
If you do not use the -o or --target option, the Starter content folder name will be the same as the one you gave when creating your Starter.
Usage
Syntax
stk create starter [NAME]
Example
stk create starter my-starter-name
Parameters
| Option | Description | Example |
|---|---|---|
-d, --description | Your Starter description. | stk create starter my-starter-name --description "My Starter description" |
-r, --remote | Git URL to set as remote repository origin. In this case, the NAME will be defined as the Git repository name. | stk create starter my-starter-name --remote https://github.com/MyGitHubOrg/my-repository |
-sgi, --skip-git-init | It will not start a Git repository. | stk create starter my-starter-name --skip-git-init |
-q, --non-interactive | It does not ask for missing inputs, returning an error when required inputs are not provided. | stk create starter my-starter-name --non-interactive |
-o, --target | The -o, --target option allows you to define a different folder name to create the Starter content. If the folder does not exist, it will be created. If you do not use the -o or --target option, the Starter content folder name will be the same as the one you gave when creating your Starter. | stk create starter my-starter-name --description "My Starter description" --target home/user/documents/my-stacks |
-t, --type | The Starter type: 'app' | stk create starter --type app |
-h, --help | Displays the command help and exits. | stk create starter --help |
stk list starter
The stk list starter command lists the Starters available. You have two options:
-
List Starters from a Workspace available to your account. In this case, you must be inside a Workspace. To do this, execute the command stk use workspace before listing the Starters.
-
List Starters outside of a Workspace. After executing the command, you need to specify the Studio and the Stack you want.
You can access the Starter's name, type, and description. The system also notifies you if a Starter or content is deprecated with the "deprecated" tag.
Usage
stk list starter
Parameters
| Option | Description | Example |
|---|---|---|
-stu, --studio | Filters and displays the list of Starters by the Studio. | stk list starter --studio studio-name |
-sta, --stack | Filters and displays the list of Starters by Stack. | stk list starter --stack stack-name |
-t, --type [app/infra] | Filter Starters by type. Accepted values are 'app' or 'infra'. | stk list starter --type infra |
-h, --help | Displays the command help and exits. | stk list starter --help |
stk validate starter
The stk validate starter command validate the structure of your Starter and it's components. The files ignored on your .gitignore will not be validated.
Usage
Syntax
stk validate starter
Example
Inside your Starter's Folder, run the following command:
stk validate starter
Parameters
| Option | Description | Example |
|---|---|---|
-v, --verbose | Show validation with more details. | stk validate starter --verbose |
-h, --help | Displays the command help and exits. | stk validate starter --help |