Install and Use Plugins
Install, list, remove, configure, verify, and debug Restish plugins.
Plugins
Install, operate, debug, and author Restish plugins.
Plugins are a first-class extension model in Restish v2. They add auth flows, middleware, loaders, formatters, command workflows, and TLS signing while keeping HTTP execution and output behavior anchored in the host CLI.
Operator Track
Start here when you want to use an existing plugin:
- Install and Use Plugins for installation, listing, removal, and debugging.
- Built-In Example Plugins to find first-party plugin binaries.
- TLS Signer Plugins for hardware-backed or external mTLS signing.
- Bulk Management for
restish-bulk. - MCP for
restish-mcp.
Author Track
Start here when you are writing a plugin:
- Plugin Quickstart for the first-time author path: choose a type, build locally, inspect the manifest, debug messages, and pick the next reference.
- Hook Plugins for auth, middleware, loaders, and formatters.
- Command Plugins for top-level workflows.
- Plugin Manifest and Plugin Messages for protocol reference.
Choosing A Type
- Choose a hook plugin for focused request, response, auth, loader, or formatter behavior.
- Choose a command plugin for workflows that need their own command and multiple host interactions.
- Choose a TLS signer plugin when the private key must remain outside Restish.
Built-In Example Plugins
Map first-party plugin binaries and fixtures to user and author goals.
Plugin Quickstart
Build the smallest useful plugin and verify that Restish discovers it.
Hook Plugins
Author auth, request middleware, response middleware, loader, and formatter hook plugins.
Command Plugins
Author top-level Restish workflows that exchange messages with the host.
TLS Signer Plugins
Use or author plugins that sign mTLS handshakes without exposing private keys to Restish.
Bulk Management
Manage API collections as local files with the restish-bulk command plugin.
Serve APIs Over MCP
Expose registered Restish APIs as MCP tools through the restish-mcp command plugin.