zeekay
4bdc9ee3e4
Comprehensive rename of all openclaw references to hanzo-bot equivalents: - Package: openclaw → @hanzo/bot - Binary: openclaw → hanzo-bot - Types: OpenClaw* → Bot* - Env vars: OPENCLAW_* → BOT_* - Android: ai.openclaw.android → ai.hanzo.bot.android - iOS/macOS: ai.openclaw.* → ai.hanzo.* - Swift modules: OpenClaw* → Bot* - Plugins: openclaw.plugin.json → bot.plugin.json - Paths: .openclaw/ → .hanzo/bot/ - URLs: github.com/openclaw → github.com/hanzoai
2.2 KiB
summary, read_when, title
| summary | read_when | title | ||
|---|---|---|---|---|
| CLI reference for `bot plugins` (list, install, uninstall, enable/disable, doctor) |
|
plugins |
bot plugins
Manage Gateway plugins/extensions (loaded in-process).
Related:
- Plugin system: Plugins
- Plugin manifest + schema: Plugin manifest
- Security hardening: Security
Commands
bot plugins list
bot plugins info <id>
bot plugins enable <id>
bot plugins disable <id>
bot plugins uninstall <id>
bot plugins doctor
bot plugins update <id>
bot plugins update --all
Bundled plugins ship with Bot but start disabled. Use plugins enable to
activate them.
All plugins must ship a bot.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
bot 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):
bot plugins install -l ./my-plugin
Uninstall
bot plugins uninstall <id>
bot plugins uninstall <id> --dry-run
bot 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 ($BOT_STATE_DIR/extensions/<id>). Use
--keep-files to keep files on disk.
--keep-config is supported as a deprecated alias for --keep-files.
Update
bot plugins update <id>
bot plugins update --all
bot plugins update <id> --dry-run
Updates only apply to plugins installed from npm (tracked in plugins.installs).