Starter Commands
In this section, you will find detailed instructions on how to manage Starters with the STK CLI.
| Command | Description |
|---|---|
| stk create starter | Creates a Starter in a Stack with the STK CLI. |
| stk list starter | Lists all Starters in a Workspace. |
| stk validate starter | Validates the structure of a Starter before publishing it in a Stack. |
stk create starter
The stk create starter command creates the basic structure of a Starter. For more details about the Starter structure, see how to create a Starter in the STK CLI.
The -o or --target option lets you define a different folder name to create the Starter content. If the folder does not exist, it will be created automatically.
If you do not use -o or --target, the Starter content folder name will be the same name you provided for the Starter.
Usage
Syntax
stk create starter [NAME]
Example
stk create starter my-starter-name
Options
| Option | Description | Example |
|---|---|---|
-d, --description | Description for your Starter. | stk create starter my-starter-name --description "My Starter description" |
-r, --remote | Git URL to set as remote repository (origin). If used, the Starter NAME will be set from the Git repository name. | stk create starter my-starter-name --remote https://github.com/MyGitHubOrg/my-repository |
-sgi, --skip-git-init | Does not initialize a Git repository. | stk create starter my-starter-name --skip-git-init |
-q, --non-interactive | Runs the command non-interactively. Returns an error when a required input is not provided. | stk create starter my-starter-name --non-interactive |
-o, --target | Sets a specific folder to create the Starter content. If the folder does not exist, it will be created. If you do not use this option, the folder name will match the Starter name. | stk create starter my-starter-name --description "My Starter description" --target home/user/documents/my-stacks |
-t, --type | Starter type. Currently supported value: app. | stk create starter --type app |
-h, --help | Displays help for the command. | stk create starter --help |
stk list starter
The stk list starter command displays the available Starters in the terminal.
You can:
- List Starters from a Workspace available to your account. To do this, first access the Workspace with stk use workspace.
- List Starters outside a Workspace by specifying the Studio and the Stack after running the command.
You can see the Starter name, type, and description. The command also marks deprecated Starters or content with the "deprecated" tag.
Usage
stk list starter
Options
| Option | Description | Example |
|---|---|---|
-stu, --studio | Filters and displays the list of Starters by 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] | Filters Starters by type. Accepted values: app or infra. | stk list starter --type infra |
-h, --help | Displays help for the command. | stk list starter --help |
stk validate starter
The stk validate starter command validates the structure of your Starter and its components. Files ignored in your .gitignore file will not be validated.
Usage
Syntax
stk validate starter
Example
In your Starter directory, run:
stk validate starter
Options
| Option | Description | Example |
|---|---|---|
-v, --verbose | Shows validation details in depth. | stk validate starter --verbose |
-h, --help | Displays help for the command. | stk validate starter --help |