Extend with Plugins



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

Note

If you are a plugin author, you will need to update your plugin to the Terminus 1.0 syntax. See Legacy Terminus Versions to compare the difference in command syntax.

Install Plugins

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

Install via Composer

Plugins published on Packagist are available to install via the Composer package manager. From a terminal window on your computer, use the following commands:

composer create-project -n -d $HOME/.terminus/plugins pantheon-systems/terminus-plugin-example:~1
       

Install via Git

Most plugins are published online as a Git repository. You can install the plugin by cloning the repository into your local plugins directory ($HOME/.terminus/plugins). This will allow you to contribute to the development of the plugin and to update the plugin using Git commands. To install a plugin using Git, find the Git URL of the plugin’s repository. On GitHub you can find it by clicking Clone or download on the repository home page:

GitHub clone URL

Then in a terminal window on your computer, use the following commands:

cd $HOME/.terminus/plugins
       git clone https://github.com/pantheon-systems/terminus-plugin-example.git

Update Plugins

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

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