Extend with Plugins

Use plugins to extend what you can do with Terminus.

Discuss in our Forum Discuss in Slack

Extend the functionality of Terminus and add commands by installing third-party plugins.

 Note

If you are a plugin author, ensure your your plugin is updated for Terminus 2.0. See Terminus 2.0 to compare the differences. Plugins that are advertised to work on Terminus 2.0 may also be used on Terminus 3.0.

Install Plugins

Depending on your Terminus version, the plugin installation process is different. Please refer to the appropriate section below.

Terminus 3

Terminus 3 ships with the plugin manager. This means that to install a plugin you should use a Terminus command like this:

terminus self:plugin:install pantheon-systems/terminus-plugin-example

Terminus 2

Add plugins within the $HOME/.terminus/plugins directory on your local workstation. You may need to create the $HOME/.terminus/plugins directory if it does not already exist:

mkdir -p $HOME/.terminus/plugins

Download a zip archive of the plugin's most recent release, then install it by unpacking the archive within $HOME/.terminus/plugins:

curl https://github.com/pantheon-systems/terminus-plugin-example/archive/1.x.tar.gz -L | tar -C ~/.terminus/plugins -xvz

Update Plugins

Depending on your Terminus version, the plugin update process is different. Please refer to the appropiate section below.

Terminus 3

Terminus 3 ships with the plugin manager. This means that to update a plugin you should use a Terminus command like this:

terminus self:plugin:update pantheon-systems/terminus-plugin-example

Terminus 2

Delete the plugin from the $HOME/.terminus/plugins directory. Download the latest version of the plugin and move the plugin directory into the $HOME/.terminus/plugins directory.

Uninstall Plugins

Depending on your Terminus version, the plugin uninstallation process is different. Please refer to the appropriate section below.

Terminus 3

Terminus 3 ships with the plugin manager. This means that to uninstall a plugin you should use a Terminus command like this:

terminus self:plugin:uninstall pantheon-systems/terminus-plugin-example

Terminus 2

Delete the plugin from the $HOME/.terminus/plugins directory.