@openpen/plugin-manager
v1.1.1
Published
Shared install/remove/list logic for OpenPen plugins — used by the CLI and the in-app marketplace.
Maintainers
Readme
@openpen/plugin-manager
Shared install / remove / list logic for OpenPen plugins. Powers openpen-cli and the in-app plugin marketplace; not intended for direct use by plugin authors.
Install
npm install @openpen/plugin-managerWhat it does
- Install an OpenPen plugin from a local path or a GitHub release zip into
~/.openpen/plugins/<scope>/<name>/, with manifest validation, SHA-256 digest verification, and atomic backup-on-failure rollback. - Remove an installed plugin by
@scope/nameid. - List installed plugins under
~/.openpen/plugins/. - Validate plugin manifests (
plugin.json) and plugin id format (@scope/name).
API surface
import { installFromPath, installFromZipUrl, removePlugin, listPlugins } from '@openpen/plugin-manager';See src/index.ts for the exported surface and types.
Where plugins live
| Path | Purpose |
|---|---|
| ~/.openpen/plugins/<scope>/<name>/dist/ | Plugin code loaded by the host |
| ~/.openpen/plugins/<scope>/<name>/plugin.json | Plugin manifest |
| ~/.openpen/plugins/<scope>/<name>/locales/ | Optional i18n bundles |
See also
- openpen-cli — the user-facing CLI that wraps this library
- Build your first plugin
- Trust Model
License
MIT
