Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installing Plugins

Vultrino plugins can be installed from local paths, git repositories, or archive URLs.

Installation Sources

From Local Path

Install a plugin from a local directory:

vultrino plugin install ./my-plugin
vultrino plugin install /absolute/path/to/plugin
vultrino plugin install ~/plugins/my-plugin

From Git Repository

Install directly from GitHub, GitLab, or other git hosts:

# Latest commit
vultrino plugin install https://github.com/user/vultrino-plugin

# Specific tag or branch
vultrino plugin install https://github.com/user/vultrino-plugin#v1.0.0
vultrino plugin install https://github.com/user/vultrino-plugin#main

From Archive URL

Install from a .tar.gz archive:

vultrino plugin install https://example.com/plugin-1.0.0.tar.gz

Build Process

When installing a plugin with a Cargo.toml, Vultrino automatically:

  1. Checks for the wasm32-wasip1 target (installs if needed)
  2. Runs cargo build --release --target wasm32-wasip1
  3. Copies the built WASM module to the plugin directory

Requirements:

  • Rust toolchain installed
  • rustup available in PATH

Managing Plugins

List Installed Plugins

vultrino plugin list

Example output:

Installed plugins:

  pgp-signing v1.0.0
    Source: https://github.com/vultrino/plugin-pgp#v1.0.0
    Installed: 2024-01-15
    Credential types: pgp_key
    MCP tools: pgp_sign, pgp_verify, pgp_get_public_key

View Plugin Details

vultrino plugin info pgp-signing

Remove a Plugin

vultrino plugin remove pgp-signing

Reload a Plugin

Reload a plugin’s WASM module without restarting:

vultrino plugin reload pgp-signing

Plugin Discovery

Plugins can be discovered in the Vultrino plugin registry (coming soon) or by searching GitHub for repositories tagged with vultrino-plugin.

Troubleshooting

Build Fails

If the WASM build fails:

  1. Ensure Rust is installed: rustup --version
  2. Check the target: rustup target list --installed
  3. Install the target manually: rustup target add wasm32-wasip1

Plugin Not Loading

Check the plugin manifest is valid:

cd ~/.vultrino/plugins/my-plugin
cat plugin.toml

Verify the WASM module exists:

ls -la *.wasm

Hot Reload Not Working

Make sure the Vultrino server has write access to the plugins directory and that the new WASM module compiles successfully.