mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-06 14:10:51 +00:00
docs(plugins): clarify clawhub npm migration
This commit is contained in:
@@ -14,9 +14,9 @@ generation, video generation, web fetch, web search, agent tools, or any
|
||||
combination.
|
||||
|
||||
You do not need to add your plugin to the OpenClaw repository. Publish to
|
||||
[ClawHub](/tools/clawhub) or npm and users install with
|
||||
[ClawHub](/tools/clawhub) and users install with
|
||||
`openclaw plugins install <package-name>`. OpenClaw tries ClawHub first and
|
||||
falls back to npm automatically.
|
||||
falls back to npm automatically for packages that still use npm distribution.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -136,7 +136,8 @@ and provider plugins have dedicated guides linked above.
|
||||
```
|
||||
|
||||
OpenClaw also checks ClawHub before npm for bare package specs like
|
||||
`@myorg/openclaw-my-plugin`.
|
||||
`@myorg/openclaw-my-plugin`; npm remains a fallback for packages that have
|
||||
not migrated to ClawHub yet.
|
||||
|
||||
**In-repo plugins:** place under the bundled plugin workspace tree — automatically discovered.
|
||||
|
||||
|
||||
@@ -8,8 +8,9 @@ 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 [ClawHub](/tools/clawhub) or npm, and
|
||||
installable with a single command.
|
||||
by the community, usually published on [ClawHub](/tools/clawhub), and installable
|
||||
with a single command. Npm remains a supported fallback for packages that have
|
||||
not moved to ClawHub yet.
|
||||
|
||||
ClawHub is the canonical discovery surface for community plugins. Do not open
|
||||
docs-only PRs just to add your plugin here for discoverability; publish it on
|
||||
@@ -151,7 +152,8 @@ We welcome community plugins that are useful, documented, and safe to operate.
|
||||
<Steps>
|
||||
<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.
|
||||
Publish to [ClawHub](/tools/clawhub) unless you specifically need npm-only
|
||||
distribution.
|
||||
See [Building Plugins](/plugins/building-plugins) for the full guide.
|
||||
|
||||
</Step>
|
||||
|
||||
@@ -477,7 +477,7 @@ The `ChannelSetupWizard` type supports `credentials`, `textInputs`, `dmPolicy`,
|
||||
|
||||
## Publishing and installing
|
||||
|
||||
**External plugins:** publish to [ClawHub](/tools/clawhub) or npm, then install:
|
||||
**External plugins:** publish to [ClawHub](/tools/clawhub), then install:
|
||||
|
||||
<Tabs>
|
||||
<Tab title="Auto (ClawHub then npm)">
|
||||
@@ -494,10 +494,11 @@ The `ChannelSetupWizard` type supports `credentials`, `textInputs`, `dmPolicy`,
|
||||
```
|
||||
</Tab>
|
||||
<Tab title="npm package spec">
|
||||
There is no matching `npm:` override. Use the normal npm package spec when you want the npm path after ClawHub fallback:
|
||||
Use npm when a package has not moved to ClawHub yet, or when you need a
|
||||
direct npm install path during migration:
|
||||
|
||||
```bash
|
||||
openclaw plugins install @myorg/openclaw-my-plugin
|
||||
openclaw plugins install npm:@myorg/openclaw-my-plugin
|
||||
```
|
||||
|
||||
</Tab>
|
||||
|
||||
@@ -27,7 +27,7 @@ the Gateway, then restart the Gateway to load it.
|
||||
<Steps>
|
||||
<Step title="Install the plugin">
|
||||
<Tabs>
|
||||
<Tab title="From npm (recommended)">
|
||||
<Tab title="From npm">
|
||||
```bash
|
||||
openclaw plugins install @openclaw/voice-call
|
||||
```
|
||||
@@ -41,6 +41,10 @@ the Gateway, then restart the Gateway to load it.
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
If npm reports the OpenClaw-owned package as deprecated, that package version
|
||||
is from an older external package train; use a current packaged OpenClaw
|
||||
build or the local folder path until a newer npm package is published.
|
||||
|
||||
Restart the Gateway afterwards so the plugin loads.
|
||||
|
||||
</Step>
|
||||
|
||||
@@ -34,6 +34,10 @@ No external `zca`/`openzca` CLI binary is required.
|
||||
openclaw plugins install @openclaw/zalouser
|
||||
```
|
||||
|
||||
If npm reports the OpenClaw-owned package as deprecated, that package version is
|
||||
from an older external package train; use a current packaged OpenClaw build or
|
||||
the local folder path until a newer npm package is published.
|
||||
|
||||
Restart the Gateway afterwards.
|
||||
|
||||
### Option B: install from a local folder (dev)
|
||||
|
||||
Reference in New Issue
Block a user