Skip to content

docs: fix incorrect CLI command in 14 extension READMEs#112057

Merged
steipete merged 1 commit into
openclaw:mainfrom
Hilbert-Gowin:fix/docs-correct-plugin-install-command
Jul 25, 2026
Merged

docs: fix incorrect CLI command in 14 extension READMEs#112057
steipete merged 1 commit into
openclaw:mainfrom
Hilbert-Gowin:fix/docs-correct-plugin-install-command

Conversation

@Hilbert-Gowin

Copy link
Copy Markdown
Contributor

What Problem This Solves

14 extension README files reference the command openclaw plugin add, which does not exist in the CLI. Users following these docs to install extensions would get a command-not-found error.

The correct command is openclaw plugins install, as registered in src/cli/plugins-cli.ts and documented in other extension READMEs (e.g., Signal, Brave).

Why This Change Was Made

The incorrect command prevents users from successfully installing these extensions by following the README instructions.

User Impact

Users can now copy-paste the install command from any extension README and have it work correctly.

Changes

Replaced openclaw plugin add with openclaw plugins install in:

  • extensions/discord/README.md
  • extensions/whatsapp/README.md
  • extensions/slack/README.md
  • extensions/matrix/README.md
  • extensions/msteams/README.md
  • extensions/line/README.md
  • extensions/feishu/README.md
  • extensions/googlechat/README.md
  • extensions/synology-chat/README.md
  • extensions/qqbot/README.md
  • extensions/nextcloud-talk/README.md
  • extensions/anthropic-vertex/README.md
  • extensions/amazon-bedrock-mantle/README.md
  • extensions/amazon-bedrock/README.md

Evidence

# The CLI only registers "plugins install", not "plugin add":
grep -n "plugin" src/cli/plugins-cli.ts | head -5
# Line 167: .command('install')

# Correct usage in Signal README (unchanged, already correct):
# openclaw plugins install @openclaw/signal

@openclaw-barnacle openclaw-barnacle Bot added channel: discord Channel integration: discord channel: googlechat Channel integration: googlechat channel: line Channel integration: line channel: matrix Channel integration: matrix channel: msteams Channel integration: msteams channel: nextcloud-talk Channel integration: nextcloud-talk channel: slack Channel integration: slack channel: whatsapp-web Channel integration: whatsapp-web channel: feishu Channel integration: feishu channel: qqbot channel: synology-chat extensions: amazon-bedrock extensions: anthropic-vertex size: XS triage: low-signal-docs Candidate: docs-only change looks low signal; maintainer review needed. labels Jul 21, 2026
@clawsweeper clawsweeper Bot added rating: 🐚 platinum hermit Good normal PR readiness with ordinary maintainer review expected. status: 👀 ready for maintainer look ClawSweeper has no concrete contributor-facing blocker left for this PR. P3 Low-priority cleanup, docs, polish, ergonomics, or speculative work. labels Jul 22, 2026
@clawsweeper

clawsweeper Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Codex review: needs real behavior proof before merge. Reviewed July 21, 2026, 12:01 AM ET / 04:01 UTC.

Summary
Replaces openclaw plugin add with openclaw plugins install in 14 extension README installation examples.

PR surface: Docs 0. Total 0 across 14 files.

Reproducibility: not applicable. as a runtime bug reproduction: the mismatch is directly verifiable by comparing the README command with the documented plugin CLI surface.

Review metrics: none identified.

Merge readiness
Overall: 🐚 platinum hermit
Proof: 🌊 off-meta tidepool
Patch quality: 🐚 platinum hermit
Result: ready for maintainer review.

Overall follows the weaker of proof and patch quality, so missing proof can cap an otherwise strong patch.

Rank-up moves:

  • none.

Next step before merge

  • [P1] No repair lane is needed; this focused docs-only PR is ready for normal maintainer review and merge gating.

Security
Cleared: The documentation-only diff introduces no security or supply-chain surface.

Review details

Best possible solution:

Merge the narrowly scoped README correction so every affected extension advertises the supported openclaw plugins install command.

Do we have a high-confidence way to reproduce the issue?

Not applicable as a runtime bug reproduction: the mismatch is directly verifiable by comparing the README command with the documented plugin CLI surface.

Is this the best way to solve the issue?

Yes. Replacing only the incorrect command with the documented plural installer is the narrowest maintainable correction and avoids introducing a legacy CLI alias.

AGENTS.md: found and applied where relevant.

Codex review notes: model internal, reasoning high; reviewed against bb45edac3e57.

Label changes

Label changes:

  • add P3: This is a small documentation correction that removes a copy-paste installation failure without changing runtime behavior.
  • add rating: 🐚 platinum hermit: Overall readiness is 🐚 platinum hermit; proof is 🌊 off-meta tidepool and patch quality is 🐚 platinum hermit.
  • add status: 👀 ready for maintainer look: ClawSweeper has no concrete contributor-facing blocker left for this PR. Not applicable: This PR changes only Markdown documentation; the CLI contract is corroborated by the public plugin CLI reference.

Label justifications:

  • P3: This is a small documentation correction that removes a copy-paste installation failure without changing runtime behavior.
  • rating: 🐚 platinum hermit: Overall readiness is 🐚 platinum hermit; proof is 🌊 off-meta tidepool and patch quality is 🐚 platinum hermit.
  • status: 👀 ready for maintainer look: ClawSweeper has no concrete contributor-facing blocker left for this PR. Not applicable: This PR changes only Markdown documentation; the CLI contract is corroborated by the public plugin CLI reference.
Evidence reviewed

PR surface:

Docs 0. Total 0 across 14 files.

View PR surface stats
Area Files Added Removed Net
Source 0 0 0 0
Tests 0 0 0 0
Docs 14 14 14 0
Config 0 0 0 0
Generated 0 0 0 0
Other 0 0 0 0
Total 14 14 14 0

What I checked:

  • Canonical CLI contract: The public plugin CLI reference documents openclaw plugins install <path-or-spec> as the installation command; it does not document a singular plugin add command. Public docs: docs/cli/plugins.md. (docs/cli/plugins.md:1, bb45edac3e57)
  • Current README mismatch: The PR base diff shows the affected extension READMEs use openclaw plugin add, so users copying the documented installation step would not reach the registered plugin installer. (extensions/discord/README.md:8, bb45edac3e57)
  • Narrow corrective patch: The branch changes only the command token in 14 extension READMEs, preserving package names and all surrounding setup guidance. (extensions/amazon-bedrock-mantle/README.md:8, 4590eade6515)
  • Current product documentation corroboration: The public documentation and existing channel-install examples use the same plural plugins install surface, so the proposed wording aligns extension documentation with the supported CLI contract. Public docs: docs/cli/plugins.md. (docs/cli/plugins.md:1, bb45edac3e57)

Likely related people:

  • steipete: Public repository security documentation recently identifies src/cli/plugins-cli.ts as the plugin installation entry point, making this a plausible routing contact for plugin-install command semantics; direct feature-history attribution was not available in this read-only environment. (role: adjacent plugin CLI contributor; confidence: low; files: src/cli/plugins-cli.ts, docs/cli/plugins.md)
What the crustacean ranks mean
  • 🦀 challenger crab: rare, exceptional readiness with strong proof, clean implementation, and convincing validation.
  • 🦞 diamond lobster: very strong readiness with only minor maintainer review expected.
  • 🐚 platinum hermit: good normal PR, likely mergeable with ordinary maintainer review.
  • 🦐 gold shrimp: useful signal, but proof or patch confidence is still limited.
  • 🦪 silver shellfish: thin signal; proof, validation, or implementation needs work.
  • 🧂 unranked krab: not merge-ready because proof is missing/unusable or there are serious correctness or safety concerns.
  • 🌊 off-meta tidepool: rating does not apply to this item.

Shiny media proof means a screenshot, video, or linked artifact directly shows the changed behavior. Runtime, network, CSP, and security claims still need visible diagnostics.

How this review workflow works
  • ClawSweeper keeps one durable marker-backed review comment per issue or PR.
  • Re-runs edit this comment so the latest verdict, findings, and automation markers stay together instead of adding duplicate bot comments.
  • A fresh review can be triggered by eligible @clawsweeper re-review comments, exact-item GitHub events, scheduled/background review runs, or manual workflow dispatch.
  • PR/issue authors and users with repository write access can comment @clawsweeper re-review or @clawsweeper re-run on an open PR or issue to request a fresh review only.
  • Maintainers can also comment @clawsweeper review to request a fresh review only.
  • Fresh-review commands do not start repair, autofix, rebase, CI repair, or automerge.
  • Maintainer-only repair and merge flows require explicit commands such as @clawsweeper autofix, @clawsweeper automerge, @clawsweeper fix ci, or @clawsweeper address review.
  • Maintainers can comment @clawsweeper explain to ask for more context, or @clawsweeper stop to stop active automation.

@Takhoffman

Copy link
Copy Markdown
Contributor

@clawsweeper automerge

@clawsweeper

clawsweeper Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

🦞🧹
ClawSweeper automerge is enabled.

  • Head: 4590eade6515
  • Label: clawsweeper:automerge
  • Action: exact-head review queued (workflow sweep.yml, event repository_dispatch).
  • Flow: review this head, repair/rebase only if needed, then re-review the exact repaired head before merge.

Draft PRs stay fix-only until GitHub marks them ready for review. Pause with /clawsweeper stop.

Automerge progress:

  • 2026-07-24 16:35:41 UTC review queued 4590eade6515 (queued)
  • 2026-07-24 19:44:23 UTC review queued 4590eade6515 (queued)

Re-review progress:

@clawsweeper clawsweeper Bot added the clawsweeper:automerge Maintainer opted this PR into bounded ClawSweeper-reviewed automerge label Jul 24, 2026
@steipete steipete self-assigned this Jul 25, 2026
Replace non-existent 'openclaw plugin add' with the correct
'openclaw plugins install' command in 14 extension README files.

The CLI only registers 'openclaw plugins install' (src/cli/plugins-cli.ts),
and the previous command would fail for users following the docs.
@steipete
steipete force-pushed the fix/docs-correct-plugin-install-command branch from 4590ead to a1d61f4 Compare July 25, 2026 12:45
@clawsweeper

clawsweeper Bot commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

ClawSweeper status: review started.

I am starting a fresh review of this pull request: docs: fix incorrect CLI command in 14 extension READMEs This is item 1/1 in the current shard. Shard 0/1.

This placeholder means the worker is alive and reading the current context. I will edit this same comment with the actual review when the claws are done clicking.

Crustacean status: shell secured, claws on keyboard, evidence pebbles being sorted.

@steipete
steipete merged commit 2579e4a into openclaw:main Jul 25, 2026
48 checks passed
@steipete

Copy link
Copy Markdown
Contributor

Merged via squash.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

channel: discord Channel integration: discord channel: feishu Channel integration: feishu channel: googlechat Channel integration: googlechat channel: line Channel integration: line channel: matrix Channel integration: matrix channel: msteams Channel integration: msteams channel: nextcloud-talk Channel integration: nextcloud-talk channel: qqbot channel: slack Channel integration: slack channel: synology-chat channel: whatsapp-web Channel integration: whatsapp-web clawsweeper:automerge Maintainer opted this PR into bounded ClawSweeper-reviewed automerge extensions: amazon-bedrock extensions: anthropic-vertex P3 Low-priority cleanup, docs, polish, ergonomics, or speculative work. rating: 🐚 platinum hermit Good normal PR readiness with ordinary maintainer review expected. size: XS status: 👀 ready for maintainer look ClawSweeper has no concrete contributor-facing blocker left for this PR. triage: low-signal-docs Candidate: docs-only change looks low signal; maintainer review needed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants