From 5b528f4dfe5ab5672ba47bcb43acdd1c99e53c60 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Mon, 4 May 2026 10:08:29 +0100 Subject: [PATCH] docs: add plugin install example --- docs/plugins/plugin-inventory.md | 20 ++++++++++++++++++++ scripts/generate-plugin-inventory-doc.mjs | 20 ++++++++++++++++++++ 2 files changed, 40 insertions(+) diff --git a/docs/plugins/plugin-inventory.md b/docs/plugins/plugin-inventory.md index 6e718f176c0..db1490b66e6 100644 --- a/docs/plugins/plugin-inventory.md +++ b/docs/plugins/plugin-inventory.md @@ -26,6 +26,26 @@ Source checkouts are different from npm installs: after `pnpm install`, bundled plugins load from `extensions/` so local edits and package-local workspace dependencies are available. +## Install a plugin + +Use the **Distribution** column to decide whether install is needed. Plugins that +say `included in OpenClaw` are already present in the core package. Official +external packages need one install, then a Gateway restart. + +For example, Discord is an official external package: + +```bash +openclaw plugins install @openclaw/discord +openclaw gateway restart +openclaw plugins inspect discord --runtime --json +``` + +Bare package specs try ClawHub first, then npm fallback. To force a source, use +`clawhub:@openclaw/discord` or `npm:@openclaw/discord`. After install, follow +the plugin's setup doc, such as [Discord](/channels/discord), to add credentials +and channel config. See [Manage plugins](/plugins/manage-plugins) for update, +uninstall, and publishing commands. + ## Core npm package | Plugin | Description | Distribution | Surface | diff --git a/scripts/generate-plugin-inventory-doc.mjs b/scripts/generate-plugin-inventory-doc.mjs index 6df64c25ab5..b8cf018f574 100644 --- a/scripts/generate-plugin-inventory-doc.mjs +++ b/scripts/generate-plugin-inventory-doc.mjs @@ -544,6 +544,26 @@ Source checkouts are different from npm installs: after \`pnpm install\`, bundle plugins load from \`extensions/\` so local edits and package-local workspace dependencies are available. +## Install a plugin + +Use the **Distribution** column to decide whether install is needed. Plugins that +say \`included in OpenClaw\` are already present in the core package. Official +external packages need one install, then a Gateway restart. + +For example, Discord is an official external package: + +\`\`\`bash +openclaw plugins install @openclaw/discord +openclaw gateway restart +openclaw plugins inspect discord --runtime --json +\`\`\` + +Bare package specs try ClawHub first, then npm fallback. To force a source, use +\`clawhub:@openclaw/discord\` or \`npm:@openclaw/discord\`. After install, follow +the plugin's setup doc, such as [Discord](/channels/discord), to add credentials +and channel config. See [Manage plugins](/plugins/manage-plugins) for update, +uninstall, and publishing commands. + ## Core npm package ${renderTable(groups.core)}