docs: update plugin install references for ClawHub-first default

OpenClaw now tries ClawHub before npm for bare plugin specs.
Update install examples and guidance across:
- building-plugins.md: intro and publish step
- sdk-setup.md: publishing section with clawhub:/npm: prefix examples
- tools/plugin.md: CLI reference table
- community.md: submission guidance and quality bar
This commit is contained in:
Vincent Koc 2026-03-22 11:58:01 -07:00
parent 6d9d9319b2
commit dbf3dd6559
4 changed files with 31 additions and 16 deletions

View File

@ -13,8 +13,10 @@ read_when:
Plugins extend OpenClaw with new capabilities: channels, model providers, speech,
image generation, web search, agent tools, or any combination.
You do not need to add your plugin to the OpenClaw repository. Publish on npm
and users install with `openclaw plugins install <npm-spec>`.
You do not need to add your plugin to the OpenClaw repository. Publish to
[ClawHub](/tools/clawhub) or npm and users install with
`openclaw plugins install <package-name>`. OpenClaw tries ClawHub first and
falls back to npm automatically.
## Prerequisites
@ -105,13 +107,14 @@ and provider plugins have dedicated guides linked above.
<Step title="Test and publish">
**External plugins:**
**External plugins:** publish to [ClawHub](/tools/clawhub) or npm, then install:
```bash
npm publish
openclaw plugins install @myorg/openclaw-my-plugin
```
OpenClaw checks ClawHub first, then falls back to npm.
**In-repo plugins:** place under `extensions/` — automatically discovered.
```bash

View File

@ -10,12 +10,15 @@ title: "Community Plugins"
Community plugins are third-party packages that extend OpenClaw with new
channels, tools, providers, or other capabilities. They are built and maintained
by the community, published on npm, and installable with a single command.
by the community, published on [ClawHub](/tools/clawhub) or npm, and
installable with a single command.
```bash
openclaw plugins install <npm-spec>
openclaw plugins install <package-name>
```
OpenClaw checks ClawHub first and falls back to npm automatically.
## Listed plugins
### Codex App Server Bridge
@ -99,8 +102,9 @@ openclaw plugins install @wecom/wecom-openclaw-plugin
We welcome community plugins that are useful, documented, and safe to operate.
<Steps>
<Step title="Publish to npm">
Your plugin must be installable via `openclaw plugins install \<npm-spec\>`.
<Step title="Publish to ClawHub or npm">
Your plugin must be installable via `openclaw plugins install \<package-name\>`.
Publish to [ClawHub](/tools/clawhub) (preferred) or npm.
See [Building Plugins](/plugins/building-plugins) for the full guide.
</Step>
@ -127,7 +131,7 @@ We welcome community plugins that are useful, documented, and safe to operate.
| Requirement | Why |
| -------------------- | --------------------------------------------- |
| Published on npm | Users need `openclaw plugins install` to work |
| Published on ClawHub or npm | Users need `openclaw plugins install` to work |
| Public GitHub repo | Source review, issue tracking, transparency |
| Setup and usage docs | Users need to know how to configure it |
| Active maintenance | Recent updates or responsive issue handling |

View File

@ -294,13 +294,20 @@ const setupSurface = createOptionalChannelSetupSurface({
## Publishing and installing
**External plugins:**
**External plugins:** publish to [ClawHub](/tools/clawhub) or npm, then install:
```bash
npm publish
openclaw plugins install @myorg/openclaw-my-plugin
```
OpenClaw tries ClawHub first and falls back to npm automatically. You can also
force a specific source:
```bash
openclaw plugins install clawhub:@myorg/openclaw-my-plugin # ClawHub only
openclaw plugins install npm:@myorg/openclaw-my-plugin # npm only
```
**In-repo plugins:** place under `extensions/` and they are automatically
discovered during build.
@ -308,13 +315,13 @@ discovered during build.
```bash
openclaw plugins search <query>
openclaw plugins install <npm-spec>
openclaw plugins install <package-name>
```
<Info>
`openclaw plugins install` runs `npm install --ignore-scripts` (no lifecycle
scripts). Keep plugin dependency trees pure JS/TS and avoid packages that
require `postinstall` builds.
For npm-sourced installs, `openclaw plugins install` runs
`npm install --ignore-scripts` (no lifecycle scripts). Keep plugin dependency
trees pure JS/TS and avoid packages that require `postinstall` builds.
</Info>
## Related

View File

@ -193,7 +193,8 @@ openclaw plugins inspect <id> --json # machine-readable
openclaw plugins status # operational summary
openclaw plugins doctor # diagnostics
openclaw plugins install <npm-spec> # install from npm
openclaw plugins install <package> # install (ClawHub first, then npm)
openclaw plugins install clawhub:<pkg> # install from ClawHub only
openclaw plugins install <path> # install from local path
openclaw plugins install -l <path> # link (no copy) for dev
openclaw plugins update <id> # update one plugin