docs(imessage): warn that cliPath wrappers must stream JSON-RPC stdio (#84330) by clawsweeper[bot] · Pull Request #84420 · openclaw/openclaw

clawsweeper · 2026-05-20T03:44:16Z

Makes #84347 merge-ready for the ClawSweeper automerge loop.
The edit pass should inspect the live PR diff, review comments, and failing checks; rebase if needed; keep the contributor branch credited; and stop only when validation is green or an external blocker is proven.
Known failing checks:

Failing check: label:FAILURE (https://github.com/openclaw/openclaw/actions/runs/26129621573/job/76851552877)

ClawSweeper 🐠 replacement reef notes:

Cluster: automerge-openclaw-openclaw-84347
Source PRs: docs(imessage): warn that cliPath wrappers must stream JSON-RPC stdio (#84330) #84347
Credit: Source PR: docs(imessage): warn that cliPath wrappers must stream JSON-RPC stdio (#84330) #84347
Validation: pnpm check:changed
Replacement reason: ClawSweeper could not update the source PR branch directly, so it opened a writable replacement PR instead.
Automerge requested by: @Takhoffman

Repair fallback: GitHub rejected the repair branch push because it updates workflow files and the ClawSweeper app token does not have workflows permission

Inherited issue-closing references from the source PR:
Fixes #84330

Co-author credit kept:

@hclsys: Co-authored-by: hcl 7755017+hclsys@users.noreply.github.com

fish notes: model gpt-5.5, reasoning high; reviewed against a371ee9.

…#84330) A custom `cliPath` wrapper or SSH proxy in front of `imsg` must behave like a transparent stdio pipe for long-lived JSON-RPC: small newline- framed messages can sit indefinitely if the wrapper buffers stdin until EOF or a large block fills. The visible symptom is `imsg rpc timeout (chats.list)` or repeated channel restarts even though `imsg rpc` is healthy. Add a <Warning> block in the 'Remote Mac over SSH' Tab listing the six interoperability requirements the issue calls out, and note that filter pipelines like `ssh host imsg | grep ...` need `stdbuf -oL` on every stage to stay safe.

…#84330)

clawsweeper · 2026-05-20T03:47:25Z

Codex review: passed.

Workflow note: Future ClawSweeper reviews update this same comment in place.

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.

Summary
The PR adds a Warning block to docs/channels/imessage.md explaining that iMessage cliPath wrappers and SSH proxies must stream long-lived JSON-RPC stdin/stdout incrementally.

Reproducibility: not applicable. for this docs-only PR. Source inspection verifies the runtime uses long-lived line-framed stdio, and current main lacks the operator warning being added.

PR rating
Overall: 🐚 platinum hermit
Proof: 🌊 off-meta tidepool
Patch quality: 🐚 platinum hermit
Summary: Docs-only patch is focused, consistent with the runtime contract, and has no blocking findings; normal docs/check gates remain the merge guard.

Rank-up moves:

none

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.

Real behavior proof
Not applicable: Real behavior proof is not required because this PR only changes files under docs/.

Next step before merge
No repair lane is needed; the automerge-armed docs-only PR has no actionable review findings for ClawSweeper to fix.

Security
Cleared: The diff changes only an iMessage documentation page and does not touch code execution, CI, dependencies, permissions, secrets, or supply-chain surfaces.

Review details

Best possible solution:

Land the localized docs warning near the iMessage Remote Mac over SSH setup after the normal required checks pass; no runtime or config change is needed.

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

Not applicable for this docs-only PR. Source inspection verifies the runtime uses long-lived line-framed stdio, and current main lacks the operator warning being added.

Is this the best way to solve the issue?

Yes. A Warning block in the existing iMessage Remote Mac over SSH section is the narrowest maintainable fix for the documentation gap.

Label justifications:

P3: This is a low-risk operator documentation improvement for a narrow iMessage setup pitfall.
rating: 🐚 platinum hermit: Current PR rating is 🐚 platinum hermit because proof is 🌊 off-meta tidepool, patch quality is 🐚 platinum hermit, and Docs-only patch is focused, consistent with the runtime contract, and has no blocking findings; normal docs/check gates remain the merge guard.
status: 🚀 automerge armed: This PR is in ClawSweeper's automerge lane. Not applicable: Real behavior proof is not required because this PR only changes files under docs/.

What I checked:

Current docs omit the warning: On current main, the Remote Mac over SSH section explains the SSH wrapper and attachment settings but closes the tab without warning operators that the wrapper must stream JSON-RPC frames promptly. Public docs: docs/channels/imessage.md. (docs/channels/imessage.md:89, 18a514e39e8b)
PR adds targeted docs coverage: The PR head adds the Warning block at the end of the Remote Mac over SSH tab and covers stdin forwarding, stdout forwarding, newline preservation, fixed-size blocking reads, stderr separation, timeout symptoms, and SSH/pipeline examples. Public docs: docs/channels/imessage.md. (docs/channels/imessage.md:121, a371ee998efe)
Runtime contract supports the doc wording: The iMessage runtime spawns the configured CLI with rpc args, keeps stdin/stdout/stderr as pipes, reads stdout by lines, writes newline-framed JSON-RPC requests, and reports imsg rpc timeout (<method>) when a response stalls. (extensions/imessage/src/client.ts:95, 18a514e39e8b)
Existing RPC reference matches the framing requirement: The RPC reference already describes the imsg integration as a stdio child process with line-delimited JSON-RPC over stdin/stdout, so this PR expands the operator-facing iMessage page rather than creating a new contract. Public docs: docs/reference/rpc.md. (docs/reference/rpc.md:20, 18a514e39e8b)
Whitespace validation is clean: The PR diff for the touched docs file has no whitespace errors under git's diff checker. Public docs: docs/channels/imessage.md. (docs/channels/imessage.md:121, a371ee998efe)
Feature-history provenance: The iMessage RPC adapter appears to originate in feat: add imessage rpc adapter, the iMessage channel was later moved under extensions/imessage, and the docs page was modernized in a dedicated iMessage docs commit. (extensions/imessage/src/client.ts:95, cbac34347b62)

Likely related people:

steipete: Introduced the iMessage RPC adapter and is the dominant contributor in the sampled iMessage runtime/docs history. (role: introduced behavior; confidence: high; commits: cbac34347b62; files: extensions/imessage/src/client.ts, extensions/imessage/src/probe.ts, docs/channels/imessage.md)
sebslight: Modernized the iMessage channel docs page that this PR updates. (role: docs area contributor; confidence: medium; commits: 6758b6bfe4d6; files: docs/channels/imessage.md)
scoootscooob: Moved the iMessage channel implementation into extensions/imessage, which is the runtime surface backing the documented cliPath behavior. (role: recent area refactor contributor; confidence: medium; commits: 0ce23dc62d37; files: extensions/imessage/src/client.ts)

Codex review notes: model gpt-5.5, reasoning high; reviewed against 18a514e39e8b.

clawsweeper · 2026-05-20T03:51:23Z

ClawSweeper PR egg

✨ Hatched: 💎 rare Neon Review Wisp

Hatch command

Comment @clawsweeper hatch when this PR is hatchable.

Hatchability rules:

Merged PRs are hatchable.
Open PRs are hatchable when they are status: 👀 ready for maintainer look, status: 🚀 automerge armed, or labeled clawsweeper:automerge.
Closed unmerged PRs are hatchable only when one of those hatchable labels is still present in the durable record.

Rarity: 💎 rare.
Trait: hums during re-review.
Image traits: location green-check meadow; accessory miniature diff map; palette amber, ink, and glacier blue; mood mischievous; pose waving from a small platform; shell smooth pearl shell; lighting warm desk-lamp glow; background little resolved-comment flags.
Share on X: post this hatch
Copy: My PR egg hatched a 💎 rare Neon Review Wisp in ClawSweeper.

What is this egg doing here?

Eggs appear after the PR passes real-behavior proof. It is here for vibes, not verdicts: it does not change labels, ratings, merge decisions, or automation.
The shell reacts to review momentum: open follow-up work warms it up, re-review makes it wobble, and a clean final review lets it hatch.
Hatchability usually comes from sufficient real-behavior proof, no blocking P0/P1/P2 findings, no security attention needed, and clean correctness. A merged PR is already final, so merge makes the egg hatchable independently.
The hatch is seeded from this repository and PR number, so the same PR keeps the same creature; the reviewed head SHA can only change safe visual details.
Rarity is just collectible sparkle: 🥚 common, 🌱 uncommon, 💎 rare, ✨ glimmer, and 🌈 legendary.

clawsweeper · 2026-05-20T03:51:35Z

🦞✅
ClawSweeper merged this PR after the passing review.

Source: clawsweeper[bot]
Feedback: structured ClawSweeper verdict: pass (sha=a371ee998efea9e7e30c9c46404b4bf7d79b6e66)
Merge status: merged by ClawSweeper automerge
Merged at: 2026-05-20T03:51:33Z
Merge commit: a57ab2448f2a

What merged:

The PR adds a Warning block to docs/channels/imessage.md explaining that iMessage cliPath wrappers and SSH proxies must stream long-lived JSON-RPC stdin/stdout incrementally.
Reproducibility: not applicable. for this docs-only PR. Source inspection verifies the runtime uses long-lived line-framed stdio, and current main lacks the operator warning being added.

Automerge notes:

PR branch already contained follow-up commit before automerge: docs(imessage): warn that cliPath wrappers must stream JSON-RPC stdio…

The automerge loop is complete.

Automerge progress:

2026-05-20 03:51:22 UTC review passed a371ee998efe (structured ClawSweeper verdict: pass (sha=a371ee998efea9e7e30c9c46404b4bf7d79b6...)

2026-05-20 03:51:35 UTC merged a371ee998efe (merged by ClawSweeper automerge)

… (#84330) (#84420) Summary: - The PR adds a Warning block to `docs/channels/imessage.md` explaining that iMessage `cliPath` wrappers and SSH proxies must stream long-lived JSON-RPC stdin/stdout incrementally. - Reproducibility: not applicable. for this docs-only PR. Source inspection verifies the runtime uses long-lived line-framed stdio, and current main lacks the operator warning being added. Automerge notes: - PR branch already contained follow-up commit before automerge: docs(imessage): warn that cliPath wrappers must stream JSON-RPC stdio… Validation: - ClawSweeper review passed for head a371ee998efea9e7e30c9c46404b4bf7d79b6e66. - Required merge gates passed before the squash merge. Prepared head SHA: a371ee998efea9e7e30c9c46404b4bf7d79b6e66 Review: openclaw/openclaw#84420 (comment) Co-authored-by: HCL <chenglunhu@gmail.com> Co-authored-by: clawsweeper <274271284+clawsweeper[bot]@users.noreply.github.com> Co-authored-by: clawsweeper[bot] <274271284+clawsweeper[bot]@users.noreply.github.com> Approved-by: takhoffman Co-authored-by: takhoffman <781889+takhoffman@users.noreply.github.com>

…openclaw#84330) (openclaw#84420) Summary: - The PR adds a Warning block to `docs/channels/imessage.md` explaining that iMessage `cliPath` wrappers and SSH proxies must stream long-lived JSON-RPC stdin/stdout incrementally. - Reproducibility: not applicable. for this docs-only PR. Source inspection verifies the runtime uses long-lived line-framed stdio, and current main lacks the operator warning being added. Automerge notes: - PR branch already contained follow-up commit before automerge: docs(imessage): warn that cliPath wrappers must stream JSON-RPC stdio… Validation: - ClawSweeper review passed for head a371ee9. - Required merge gates passed before the squash merge. Prepared head SHA: a371ee9 Review: openclaw#84420 (comment) Co-authored-by: HCL <chenglunhu@gmail.com> Co-authored-by: clawsweeper <274271284+clawsweeper[bot]@users.noreply.github.com> Co-authored-by: clawsweeper[bot] <274271284+clawsweeper[bot]@users.noreply.github.com> Approved-by: takhoffman Co-authored-by: takhoffman <781889+takhoffman@users.noreply.github.com>

HCL and others added 2 commits May 20, 2026 03:39

docs(imessage): warn that cliPath wrappers must stream JSON-RPC stdio (…

a371ee9

…#84330)

openclaw-barnacle Bot added docs Improvements or additions to documentation channel: imessage Channel integration: imessage labels May 20, 2026

clawsweeper Bot added the status: 🚀 automerge armed This PR is in ClawSweeper's automerge lane. label May 20, 2026

openclaw-barnacle Bot added the size: XS label May 20, 2026

clawsweeper Bot added the clawsweeper Tracked by ClawSweeper automation label May 20, 2026

clawsweeper Bot mentioned this pull request May 20, 2026

docs(imessage): warn that cliPath wrappers must stream JSON-RPC stdio (#84330) #84347

Closed

openclaw-barnacle Bot removed the proof: supplied External PR includes structured after-fix real behavior proof. label May 20, 2026

clawsweeper Bot merged commit a57ab24 into main May 20, 2026
89 of 93 checks passed

clawsweeper Bot deleted the clawsweeper/automerge-openclaw-openclaw-84347 branch May 20, 2026 03:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs(imessage): warn that cliPath wrappers must stream JSON-RPC stdio (#84330)#84420

docs(imessage): warn that cliPath wrappers must stream JSON-RPC stdio (#84330)#84420
clawsweeper[bot] merged 2 commits into
mainfrom
clawsweeper/automerge-openclaw-openclaw-84347

clawsweeper Bot commented May 20, 2026

Uh oh!

clawsweeper Bot commented May 20, 2026 •

edited

Loading

Uh oh!

clawsweeper Bot commented May 20, 2026

Uh oh!

Uh oh!

clawsweeper Bot commented May 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

clawsweeper Bot commented May 20, 2026

Uh oh!

clawsweeper Bot commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

clawsweeper Bot commented May 20, 2026

Hatch command

Uh oh!

Uh oh!

clawsweeper Bot commented May 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

clawsweeper Bot commented May 20, 2026 •

edited

Loading