⚙️ Installing and Using Plugins¶
Meerschaum gives you the ability to easily install and create plugins. Refer to the guide below on how to install, write, and publish plugins.
To install plugins, run the
install plugins command, followed by the names of the plugins you wish to install, for example:
If you would like to install plugins from a private Meerschaum repository, you can specify from where you would like to download the plugin with the
-r flag. For example, to install the plugin
example from your private Meerschaum API
api:myapi, you would execute:
Any Meerschaum API instance can act as a Meerschaum repository, and the default repository is the public
api.mrsm.io repository. Follow the steps below to change your default repository to a private repository:
- Open your configuration file with
mrsm edit config
- Change value of
meerschaum:default_repositoryto the Connector Keys of your repository.
If you've written or installed plugins, you can host them on your own private repository. You will need a user login to your private repostitory to host plugins. Replace the values in angle brackets (
<>) with your own values.
Create a user account on your Meerschaum instance with
register user <username>.
If you are connecting to an existing repository, skip to step 3.
Start the API server with
Register and upload the plugin to your private repository with
register plugin <plugin> --repo api:<label>.
If you're uploading to your own machine, use
api:localas the repository.
How you use a plugin depends on its type: whether it's a data, action, or API plugin, and sometimes plugins can be all three.
To use a data plugin (e.g.
noaa), bootstrap a pipe and choose the the plugin as the connector (e.g.
To use an action plugin, simply execute the new actions provided by the plugin. You can see the available actions with
To use an API plugin, launch the web API with