|
Download docs/cli/plugins.md from shimen/shinclaw: direct link, hf CLI and curl.
- Browser
- Download file 2.39 kB
-
https://huggingface.co/spaces/shimen/shinclaw/resolve/main/docs/cli/plugins.md
- Command line
-
hf download hf://spaces/shimen/shinclaw/docs/cli/plugins.md
-
curl -L -o plugins.md https://huggingface.co/spaces/shimen/shinclaw/resolve/main/docs/cli/plugins.md
2.39 kB
| summary: "CLI reference for `openclaw plugins` (list, install, uninstall, enable/disable, doctor)" | |
| read_when: | |
| - You want to install or manage in-process Gateway plugins | |
| - You want to debug plugin load failures | |
| title: "plugins" | |
| # `openclaw plugins` | |
| Manage Gateway plugins/extensions (loaded in-process). | |
| Related: | |
| - Plugin system: [Plugins](/tools/plugin) | |
| - Plugin manifest + schema: [Plugin manifest](/plugins/manifest) | |
| - Security hardening: [Security](/gateway/security) | |
| ## Commands | |
| ```bash | |
| openclaw plugins list | |
| openclaw plugins info <id> | |
| openclaw plugins enable <id> | |
| openclaw plugins disable <id> | |
| openclaw plugins uninstall <id> | |
| openclaw plugins doctor | |
| openclaw plugins update <id> | |
| openclaw plugins update --all | |
| ``` | |
| Bundled plugins ship with OpenClaw but start disabled. Use `plugins enable` to | |
| activate them. | |
| All plugins must ship a `openclaw.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 | |
| ```bash | |
| openclaw plugins install <path-or-spec> | |
| ``` | |
| 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`): | |
| ```bash | |
| openclaw plugins install -l ./my-plugin | |
| ``` | |
| ### Uninstall | |
| ```bash | |
| openclaw plugins uninstall <id> | |
| openclaw plugins uninstall <id> --dry-run | |
| openclaw 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 (`$OPENCLAW_STATE_DIR/extensions/<id>`). Use | |
| `--keep-files` to keep files on disk. | |
| `--keep-config` is supported as a deprecated alias for `--keep-files`. | |
| ### Update | |
| ```bash | |
| openclaw plugins update <id> | |
| openclaw plugins update --all | |
| openclaw plugins update <id> --dry-run | |
| ``` | |
| Updates only apply to plugins installed from npm (tracked in `plugins.installs`). | |