Skip to main content
Version: v4.5.0

Description

The stk-legacy create plugin command allows you to create new Plugins for StackSpot.

How does it work?

When you run the command in the terminal in a Stack folder, a sub-folder is generated with the structure to create the Plugin.
The user must edit the plugin.yaml file and configure the Plugin's input parameters.

Create Plugins in separate repositories

If you want to create a Plugin separate from a Stack so that it can be used in more than one Stack, run the command in the terminal outside the Stack folder. After that, a folder is generated with the structure to create the Plugin.

This folder initializes as a Git repository.

The user must edit the plugin.yaml file and configure the Plugin's input parameters.

Parameters

Check the available options in the command:

ParameterDescription
NAMEDefines the Plugin name. If the name is not entered, the repository name will be --remote.
--remoteThis parameter defines the Git repository remote URL that will be used as the origin for the Plugin. If you don't enter remote, you will need to run git add remote to get the Plugin published to Git. (You should only use this if you are using separate Plugin repositories.)
--remoteThis parameter defines the Git repository remote URL that will be used as the origin for the Plugin. If you don't enter remote, you will need to run git add remote to get the Plugin published to Git. (You should only use this if you are using separate Plugin repositories.)

Deprecated Parameters

caution

The parameters below are deprecated.

ParameterDescription
--types Defines Plugin's types. The plugin can be applied to a stack created with stk create app, stk create env or both. If applied with stk create app, the values are: app and env. To define more than one Plugin type, use a comma.
--deployAdds a life cycle section to plugin.yaml, where you can define the commands executed by stk deploy from the STK CLI.

Creating a Plugin app example

Read more

Was this page helpful?