diff --git a/docs/plugins/building-plugins.md b/docs/plugins/building-plugins.md index 305cc14f749..a41572ac309 100644 --- a/docs/plugins/building-plugins.md +++ b/docs/plugins/building-plugins.md @@ -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 `. +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 `. OpenClaw tries ClawHub first and +falls back to npm automatically. ## Prerequisites @@ -105,13 +107,14 @@ and provider plugins have dedicated guides linked above. - **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 diff --git a/docs/plugins/community.md b/docs/plugins/community.md index 8c539db0878..2c6a090e7d8 100644 --- a/docs/plugins/community.md +++ b/docs/plugins/community.md @@ -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 +openclaw plugins install ``` +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. - - Your plugin must be installable via `openclaw plugins install \`. + + Your plugin must be installable via `openclaw plugins install \`. + Publish to [ClawHub](/tools/clawhub) (preferred) or npm. See [Building Plugins](/plugins/building-plugins) for the full guide. @@ -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 | diff --git a/docs/plugins/sdk-setup.md b/docs/plugins/sdk-setup.md index e9df3e86141..65bc31a8518 100644 --- a/docs/plugins/sdk-setup.md +++ b/docs/plugins/sdk-setup.md @@ -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 -openclaw plugins install +openclaw plugins install ``` - `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. ## Related diff --git a/docs/tools/plugin.md b/docs/tools/plugin.md index 06f9f5a9a2c..0e8aaa4ee58 100644 --- a/docs/tools/plugin.md +++ b/docs/tools/plugin.md @@ -193,7 +193,8 @@ openclaw plugins inspect --json # machine-readable openclaw plugins status # operational summary openclaw plugins doctor # diagnostics -openclaw plugins install # install from npm +openclaw plugins install # install (ClawHub first, then npm) +openclaw plugins install clawhub: # install from ClawHub only openclaw plugins install # install from local path openclaw plugins install -l # link (no copy) for dev openclaw plugins update # update one plugin