docs: add plugin install example · openclaw/openclaw@5b528f4
steipete
·
2026-05-04
·
via Recent Commits to openclaw:main
| Original file line number | Diff line number | Diff line change |
|---|
@@ -26,6 +26,26 @@ Source checkouts are different from npm installs: after `pnpm install`, bundled
|
26 | 26 | plugins load from `extensions/<id>` so local edits and package-local workspace |
27 | 27 | dependencies are available. |
28 | 28 | |
| 29 | +## Install a plugin |
| 30 | + |
| 31 | +Use the **Distribution** column to decide whether install is needed. Plugins that |
| 32 | +say `included in OpenClaw` are already present in the core package. Official |
| 33 | +external packages need one install, then a Gateway restart. |
| 34 | + |
| 35 | +For example, Discord is an official external package: |
| 36 | + |
| 37 | +```bash |
| 38 | +openclaw plugins install @openclaw/discord |
| 39 | +openclaw gateway restart |
| 40 | +openclaw plugins inspect discord --runtime --json |
| 41 | +``` |
| 42 | + |
| 43 | +Bare package specs try ClawHub first, then npm fallback. To force a source, use |
| 44 | +`clawhub:@openclaw/discord` or `npm:@openclaw/discord`. After install, follow |
| 45 | +the plugin's setup doc, such as [Discord](/channels/discord), to add credentials |
| 46 | +and channel config. See [Manage plugins](/plugins/manage-plugins) for update, |
| 47 | +uninstall, and publishing commands. |
| 48 | + |
29 | 49 | ## Core npm package |
30 | 50 | |
31 | 51 | | Plugin | Description | Distribution | Surface | |
|
| Original file line number | Diff line number | Diff line change |
|---|
@@ -544,6 +544,26 @@ Source checkouts are different from npm installs: after \`pnpm install\`, bundle
|
544 | 544 | plugins load from \`extensions/<id>\` so local edits and package-local workspace |
545 | 545 | dependencies are available. |
546 | 546 | |
| 547 | +## Install a plugin |
| 548 | + |
| 549 | +Use the **Distribution** column to decide whether install is needed. Plugins that |
| 550 | +say \`included in OpenClaw\` are already present in the core package. Official |
| 551 | +external packages need one install, then a Gateway restart. |
| 552 | + |
| 553 | +For example, Discord is an official external package: |
| 554 | + |
| 555 | +\`\`\`bash |
| 556 | +openclaw plugins install @openclaw/discord |
| 557 | +openclaw gateway restart |
| 558 | +openclaw plugins inspect discord --runtime --json |
| 559 | +\`\`\` |
| 560 | + |
| 561 | +Bare package specs try ClawHub first, then npm fallback. To force a source, use |
| 562 | +\`clawhub:@openclaw/discord\` or \`npm:@openclaw/discord\`. After install, follow |
| 563 | +the plugin's setup doc, such as [Discord](/channels/discord), to add credentials |
| 564 | +and channel config. See [Manage plugins](/plugins/manage-plugins) for update, |
| 565 | +uninstall, and publishing commands. |
| 566 | + |
547 | 567 | ## Core npm package |
548 | 568 | |
549 | 569 | ${renderTable(groups.core)} |
|
此内容由惯性聚合(RSS阅读器)自动聚合整理，仅供阅读参考。 原文来自 — 版权归原作者所有。
