Skip to content

agent-install.en.md

Latest commit

 

History

History
108 lines (75 loc) · 2.98 KB

agent-install.en.md

File metadata and controls

108 lines (75 loc) · 2.98 KB

Agent Install

中文版

npm release install steps

  1. Install the plugin.
openclaw plugins install @1panel-dev/clawswarm

If this step returns 429 Rate Limit Exceeded, ClawHub is rate-limiting. Do not leave the user blocked here. Guide them through manual npm installation instead:

cd /tmp
PKG=$(npm pack @1panel-dev/clawswarm)
mkdir -p /tmp/clawswarm-pkg
cd /tmp/clawswarm-pkg
tar xzf "/tmp/$PKG"
cp -r /tmp/clawswarm-pkg/package /home/node/.openclaw/extensions/clawswarm
cd /home/node/.openclaw/extensions/clawswarm
npm install --omit=dev

If /home/node/.openclaw/extensions/clawswarm already exists, do not tell the user to delete it blindly. Have them inspect it first; if it contains local changes, back it up before replacing it.

If you see missing config errors for baseUrl, outboundToken, or inboundSigningSecret at this step, do not stop. Continue and guide the user to complete the config.

  1. Enable the plugin.
openclaw plugins enable clawswarm

  1. Tell the user to open the ClawSwarm client, go to the OpenClaw page, and create a new instance or edit an existing one.

  2. Tell the user to fill in these values in the instance drawer:

  • OpenClaw URL Ask the user to enter the current OpenClaw instance URL.
  • Gateway Token Ask the user to enter the token currently used by the OpenClaw Gateway.
  1. Tell the user to save the instance first.

After the instance is saved successfully, ClawSwarm will generate:

  • outboundToken
  • inboundSigningSecret

Only after that will the OpenClaw JSON Config become available to copy.

  1. Tell the user to click the copy icon next to OpenClaw JSON Config in the instance drawer, then paste the copied JSON snippet directly to you.

The client will generate the full OpenClaw config snippet, including:

  • plugins.allow
  • plugins.entries.clawswarm
  • skills
  • channels.clawswarm.accounts.default.baseUrl
  • outboundToken
  • inboundSigningSecret
  • gateway.baseUrl
  • webchatMirror.includeIntermediateMessages

The user only needs to fill in Gateway Token. The rest is generated by ClawSwarm.

  1. After the user sends the JSON snippet, you open the OpenClaw config file.

Common path:

~/.openclaw/openclaw.json
  1. Merge the OpenClaw JSON Config sent by the user into openclaw.json yourself.

Notes:

  • Do not overwrite the whole file.
  • If plugins, skills, or channels already exist in openclaw.json, review and merge them carefully by hand.
  • plugins.allow does not support wildcards like ["*"].
  • You must explicitly list clawswarm.
  • Unknown plugin IDs will fail config validation.
  1. After the config is written, tell the user to restart the Gateway.
openclaw gateway restart
  1. After the user finishes the restart, run verification.
openclaw plugins list
openclaw plugins inspect clawswarm
openclaw skills list
  1. Report back to the user:
  • installed
  • enabled
  • config written
  • Gateway restarted
  • health OK
  • agents OK