Commands
STK CLI commands can be divided into three categories:
- Core Commands: Used by both creator and user;
- Creator Commands: Used to create Stacks, that is, commands focused on the creation and availability of Templates, Plugins, Stacks, and Stackfiles;
- User Commands: Used to use Stacks available for creating applications and environments;
- Enterprise Commands: Used exclusively in the Enterprise version of StackSpot.
Core Commands
Command | Description |
---|---|
stk init | Used in the initialization and configuration of the STK CLI tool in your environment. |
stk --help | --help shows more information about the commands and their parameters. |
stk --version | It shows the current version installed. |
stk upgrade | Updates the CLI version when a new one is available. |
Creator Commands
Command | Description |
---|---|
stk create stack | Creates a repository for the Stack of Templates and Plugins. |
stk delete stack | Removes a Stack that was previously imported with the stk import stack command. |
stk create template | Creates the structure of a Stack Template that contains the files needed to create a Template. |
stk add template | Adds templates to the stacks already created by the stk create stack command. |
stk delete template | Remove Templates within a Stack project. |
stk create plugin | Allows you to create new Plugins for StackSpot. |
stk add plugin | Adds Plugins to Stacks already created by the stk create stack command. |
stk delete plugin | Remove Plugins within a Stack project. |
stk create stackfile | Creates a base file from a Stackfile in the current directory. |
stk create task | Creates a base file of a task in the current stack. |
User Commands
Command | Description |
---|---|
stk import stack | Adds a Stack to your project. |
stk update stack | Updates all Stacks available in StackSpot or any other in your application. |
stk list stack | Lists the available stacks from the installation or that have been added by the stk add stack command. Filters the Stacks by their name or by description with the --filter parameter. |
stk list template | Returns a list of all the Templates available in the user's Stacks. |
stk list plugin | Lists the Plugins available in the official StackSpot Stack, and those added by the user himself. Filters the Plugins by type, allowing the user to know which ones apply in an application Stack or in an environment Stack. |
stk list task | Returns a list of all the tasks available in the user's stack. |
stk apply plugin | Adds new functionality to your environment and application design. |
stk list stackfile | Lists the Stackfiles available by default in the Stacks installed on the STK CLI. |
stk create app | Create an app to implement the functionality of an application. You can relate this app to an environment to make use of shared resources defined in it, and also assign a remote Git repository for the app. |
stk run | Execute the commands defined in the task used as argument. |
Enterprise Commands
Command | Description |
---|---|
stk login | Logs into a StackSpot Enterprise account. |
stk logout | Realiza o logout da conta do StackSpot Enterprise. |
- Check out the complete list and more details in the command list section.
Was this page helpful?