Using Plugins

Plugins in Shipa are executables that can have and perform different functions within the applications. Since it runs in your local CLI, plugins are modular, can be distributed and built by users themselves.

Creating Plugins

You can use Shell Script, Python, Ruby, or other programming languages for creating your plugins.

As an example, to create a Hello World plugin that just prints “Hello World” on the screen, we can use Shell Script when creating the plugin:

#!/bin/bash -e
echo "Hello World"

To use gist (https://gist.github.com) as the plugin host, run the plugin install command to install it.

shipa plugin install hello <URL>

Installing Plugins

📘

Installing from a URL

shipa plugin install command only supports installing plugin accessible over HTTP(s) URL.

Install local plugin from your filesystem

Copy the plugin to $HOME/.shipa/plugins.

cp hello $HOME/.shipa/plugins

Plugin accessible over HTTP(s) URL

The plugin install command downloads the plugin file to $HOME/.shipa/plugins. The syntax for this command is:

shipa plugin install <plugin-name> <plugin-url>

Listing Plugins

To list all installed plugins, use the plugin list command:

shipa plugin list

Executing Plugins

To execute a plugin, use the following pattern:

shipa <plugin-name> <arg>

Removing Plugins

To remove a plugin, use the plugin remove command. This passes the name of the plugin as an argument.

shipa plugin remove <plugin-name>

Did this page help you?