Skip to main content

​
openaeon plugins

Manage Gateway plugins/extensions (loaded in-process). Related:

​
Commands

openaeon plugins list
openaeon plugins info <id>
openaeon plugins enable <id>
openaeon plugins disable <id>
openaeon plugins uninstall <id>
openaeon plugins doctor
openaeon plugins update <id>
openaeon plugins update --all
Bundled plugins ship with OpenAEON but start disabled. Use plugins enable to activate them. All plugins must ship a openaeon.plugin.json file with an inline JSON Schema (configSchema, even if empty). Missing/invalid manifests or schemas prevent the plugin from loading and fail config validation.

​
Install

openaeon plugins install <path-or-spec>
openaeon plugins install <npm-spec> --pin
Security note: treat plugin installs like running code. Prefer pinned versions. Npm specs are registry-only (package name + optional version/tag). Git/URL/file specs are rejected. Dependency installs run with --ignore-scripts for safety. Supported archives: .zip, .tgz, .tar.gz, .tar. Use --link to avoid copying a local directory (adds to plugins.load.paths): 
openaeon plugins install -l ./my-plugin
Use --pin on npm installs to save the resolved exact spec (name@version) in plugins.installs while keeping the default behavior unpinned.

​
Uninstall

openaeon plugins uninstall <id>
openaeon plugins uninstall <id> --dry-run
openaeon plugins uninstall <id> --keep-files
uninstall removes plugin records from plugins.entries, plugins.installs, the plugin allowlist, and linked plugins.load.paths entries when applicable. For active memory plugins, the memory slot resets to memory-core. By default, uninstall also removes the plugin install directory under the active state dir extensions root ($OPENAEON_STATE_DIR/extensions/<id>). Use --keep-files to keep files on disk. --keep-config is supported as a deprecated alias for --keep-files.

​
Update

openaeon plugins update <id>
openaeon plugins update --all
openaeon plugins update <id> --dry-run
Updates only apply to plugins installed from npm (tracked in plugins.installs). When a stored integrity hash exists and the fetched artifact hash changes, OpenAEON prints a warning and asks for confirmation before proceeding. Use global --yes to bypass prompts in CI/non-interactive runs.