Commands
These are the commands for StackSpot legacy. You need to use
stk-legacy.
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-legacy init | Used in the initialization and configuration of the STK CLI tool in your environment. |
| stk-legacy --help | --help shows more information about the commands and their parameters. |
| stk-legacy --version | It shows the current version installed. |
| stk-legacy upgrade | Updates the CLI version when a new one is available. |
Creator Commands
| Command | Description |
|---|---|
| stk-legacy create stack | Creates a repository for the Stack of Templates and Plugins. |
| stk-legacy delete stack | Removes a Stack that was previously imported with the stk-legacy import stack command. |
| stk-legacy create template | Creates the structure of a Stack Template that contains the files needed to create a Template. |
| stk-legacy add template | Adds templates to the stacks already created by the stk-legacy create stack command. |
| stk-legacy delete template | Remove Templates within a Stack project. |
| stk-legacy create plugin | Allows you to create new Plugins for StackSpot. |
| stk-legacy add plugin | Adds Plugins to Stacks already created by the stk-legacy create stack command. |
| stk-legacy delete plugin | Remove Plugins within a Stack project. |
| stk-legacy create stackfile | Creates a base file from a Stackfile in the current directory. |
| stk-legacy create task | Creates a base file of a task in the current stack. |
User Commands
| Command | Description |
|---|---|
| stk-legacy import stack | Adds a Stack to your project. |
| stk-legacy update stack | Updates all Stacks available in StackSpot or any other in your application. |
| stk-legacy list stack | Lists the available stacks from the installation or that have been added by the stk-legacy add stack command. Filters the Stacks by their name or by description with the --filter parameter. |
| stk-legacylist template | Returns a list of all the Templates available in the user's Stacks. |
| stk-legacy 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-legacy list task | Returns a list of all the tasks available in the user's stack. |
| stk-legacy apply plugin | Adds new functionality to your environment and application design. |
| stk-legacy list stackfile | Lists the Stackfiles available by default in the Stacks installed on the STK CLI. |
| stk-legacy 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-legacy run | Execute the commands defined in the task used as argument. |
Enterprise Commands
| Command | Description |
|---|---|
| stk-legacy login | Logs into a StackSpot Enterprise account. |
| stk-legacy 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?