Make exec command highlighting optional by jesse-merhi · Pull Request #79348 · openclaw/openclaw

jesse-merhi · 2026-05-08T10:23:54Z

Summary

Adds tools.exec.commandHighlighting, disabled by default, with global and per-agent opt-in support.
Skips exec command span generation and gateway span propagation unless command highlighting is explicitly enabled.
Updates config metadata, generated docs baseline, exec docs, and changelog coverage for the default-off setting.

Verification

PATH="/opt/homebrew/bin:$PATH" pnpm test src/agents/bash-tools.exec-approval-request.test.ts src/config/schema.test.ts src/config/schema.help.quality.test.ts src/gateway/server-methods/server-methods.test.ts
PATH="/opt/homebrew/bin:$PATH" pnpm config:schema:check
PATH="/opt/homebrew/bin:$PATH" pnpm config:docs:check
PATH="/opt/homebrew/bin:$PATH" pnpm docs:check-mdx
PATH="/opt/homebrew/bin:$PATH" pnpm check:changed
git diff --check

clawsweeper · 2026-05-08T10:26:59Z

Codex review: passed.

Summary
The PR adds a default-off tools.exec.commandHighlighting config option and gates exec approval command span generation/propagation behind it while updating schema, docs, tests, generated baseline hashes, and changelog.

Reproducibility: not applicable. this is a feature/config PR rather than a bug report. The behavior is source-verifiable in the PR head and covered by focused exec approval/config tests.

Real behavior proof
Not applicable: Real behavior proof is not required for this member-authored PR; the body lists targeted verification commands, but this read-only review did not run them.

Next step before merge
No narrow automated repair target remains; the clean path is exact-head CI/automerge plus maintainer acceptance of the config policy.

Security
Cleared: The diff changes exec approval presentation and config only, adds no dependency or supply-chain surface, and defaults the new highlighting behavior off.

Review details

Best possible solution:

Land through the opted-in automerge path after exact-head CI and mergeability are green, assuming maintainers accept the default-off exec approval highlighting policy.

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

Not applicable: this is a feature/config PR rather than a bug report. The behavior is source-verifiable in the PR head and covered by focused exec approval/config tests.

Is this the best way to solve the issue?

Yes: the narrow config gate keeps command highlighting default-off and gates both agent-side span generation and gateway propagation while preserving sanitizer and unsupported-shell guards. The remaining question is policy/merge readiness rather than a code repair.

What I checked:

Live PR state: GitHub API reports the PR open at head f625052 with authorAssociation MEMBER and labels including maintainer and clawsweeper:automerge. (f62505256dad)
Agent-side opt-in gate: The PR head only preserves explicit spans or resolves parser-derived spans when params.commandHighlighting === true; otherwise it sends no command spans. (src/agents/bash-tools.exec-approval-request.ts:272, f62505256dad)
Gateway propagation gate: The gateway handler resolves runtime config for the effective agent and only normalizes/propagates commandSpans when command highlighting is enabled and display sanitization did not change offsets. (src/gateway/server-methods/exec-approval.ts:245, f62505256dad)
Config contract: The PR adds commandHighlighting to the exec config type, runtime zod schema, and effective config resolution path with per-agent override before global fallback. (src/config/types.tools.ts:287, f62505256dad)
Docs contract: The exec approvals docs describe tools.exec.commandHighlighting as default false, presentation-only, and configurable globally or per agent. Public docs: docs/tools/exec-approvals.md. (docs/tools/exec-approvals.md:169, f62505256dad)
Focused test coverage: The PR-head gateway tests cover opt-in span normalization, default-off dropping, explicit false dropping, and the sanitizer-offset guard with highlighting enabled. (src/gateway/server-methods/server-methods.test.ts:1480, f62505256dad)

Likely related people:

jesse-merhi: Introduced parser-derived exec approval command spans and subsequent non-POSIX/Windows span guards, and authored the current config-gating PR. (role: feature owner and recent area contributor; confidence: high; commits: 297a16453661, a70d46717c77, 2401ece533f4; files: src/agents/bash-tools.exec-approval-request.ts, src/gateway/server-methods/exec-approval.ts, src/infra/command-explainer/format.ts)
steipete: Recent history shows adjacent exec approval command-analysis refactors and config/tool-surface work that this PR extends. (role: recent adjacent contributor; confidence: medium; commits: 3f7e6eebc2f5, bd0e10a2f68f, 5e8e77ed83eb; files: src/gateway/server-methods/exec-approval.ts, src/config/types.tools.ts, src/agents/pi-tools.ts)
JerranC: Recently changed the same config and tool-policy surfaces that the new exec config field plugs into. (role: recent adjacent config/tool-policy contributor; confidence: medium; commits: 530b892f0684; files: src/config/types.tools.ts, src/config/zod-schema.agent-runtime.ts, src/agents/pi-tools.ts)

Remaining risk / open question:

Exact-head CI for f625052 still had queued checks when inspected.
GitHub PR API reported mergeability as still being calculated after the latest head update.

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

Re-review progress:

State: Failed
Detail: The targeted re-review did not finish cleanly. Check the workflow run for details.
Run: https://github.com/openclaw/clawsweeper/actions/runs/25687058397
Updated: 2026-05-11T17:55:32.399Z

Copilot

Pull request overview

This PR makes exec approval command highlighting opt-in by introducing tools.exec.commandHighlighting (default: false) and gating both command-span generation (agent side) and command-span propagation (gateway side) on that setting.

Changes:

Add tools.exec.commandHighlighting to config types, runtime schema, labels/help metadata, generated docs baseline, and changelog.
Skip generating command spans for exec approval requests unless highlighting is explicitly enabled.
Skip including commandSpans in gateway exec approval request broadcasts unless highlighting is enabled (global or per-agent).

Reviewed changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/gateway/server-methods/server-methods.test.ts	Extends exec approval handler tests to cover default-off and explicit enable/disable behavior for command spans.
src/gateway/server-methods/exec-approval.ts	Gates `commandSpans` normalization/propagation behind resolved `commandHighlighting` from runtime config.
src/config/zod-schema.agent-runtime.ts	Adds `tools.exec.commandHighlighting` to the runtime zod schema.
src/config/types.tools.ts	Adds `commandHighlighting?: boolean` to `ExecToolConfig` with default-off docs.
src/config/schema.test.ts	Validates schema acceptance of `tools.exec.commandHighlighting` in global and agent scopes.
src/config/schema.labels.ts	Adds a UI label for `tools.exec.commandHighlighting`.
src/config/schema.help.ts	Adds help text clarifying highlighting is presentation-only and default-off.
src/config/schema.help.quality.test.ts	Adds `tools.exec.commandHighlighting` to help-quality key coverage.
src/config/exec-command-highlighting.ts	Introduces resolver for effective command-highlighting enablement (global + per-agent).
src/agents/pi-tools.ts	Threads resolved exec `commandHighlighting` into exec tool defaults and overrides.
src/agents/bash-tools.exec.ts	Passes `commandHighlighting` through to node/gateway approval request paths.
src/agents/bash-tools.exec-types.ts	Extends `ExecToolDefaults` with `commandHighlighting?: boolean`.
src/agents/bash-tools.exec-host-node.types.ts	Extends node-host exec params with `commandHighlighting?: boolean`.
src/agents/bash-tools.exec-host-node.ts	Forwards `commandHighlighting` into the gateway approval request context.
src/agents/bash-tools.exec-host-gateway.ts	Forwards `commandHighlighting` into gateway allowlist approval registration.
src/agents/bash-tools.exec-approval-request.ts	Avoids loading/generating command spans unless `commandHighlighting === true`.
src/agents/bash-tools.exec-approval-request.test.ts	Adds coverage to ensure spans are generated only when highlighting is enabled.
docs/tools/exec.md	Documents `tools.exec.commandHighlighting` in exec tool notes.
docs/tools/exec-approvals.md	Adds a dedicated section describing `tools.exec.commandHighlighting` semantics/scope.
docs/gateway/config-tools.md	Updates the config example to include `commandHighlighting: false`.
docs/.generated/config-baseline.sha256	Updates generated config baseline hashes to reflect the new field.
CHANGELOG.md	Records the addition of `tools.exec.commandHighlighting`.

jesse-merhi · 2026-05-08T10:54:55Z

/clawsweeper re-review

clawsweeper · 2026-05-08T10:56:12Z

🦞🧹
ClawSweeper re-review requested.

I asked ClawSweeper to review this item again.
Action: item re-review queued (workflow sweep.yml, event repository_dispatch).
Result: the existing ClawSweeper review comment will be edited in place when the review finishes.

Re-review progress:

State: Complete
Detail: The targeted re-review finished, the durable review comment was updated, and the synced verdict was routed.
Run: https://github.com/openclaw/clawsweeper/actions/runs/25551781907
Updated: 2026-05-08T11:04:49.479Z

jesse-merhi · 2026-05-08T14:29:16Z

/clawsweeper re-review

clawsweeper · 2026-05-08T14:30:34Z

🦞🧹
ClawSweeper re-review requested.

I asked ClawSweeper to review this item again.
Action: item re-review queued (workflow sweep.yml, event repository_dispatch).
Result: the existing ClawSweeper review comment will be edited in place when the review finishes.

Re-review progress:

State: Failed
Detail: The targeted re-review did not finish cleanly. Check the workflow run for details.
Run: https://github.com/openclaw/clawsweeper/actions/runs/25648835604
Updated: 2026-05-11T03:43:09.948Z

jesse-merhi · 2026-05-08T14:38:58Z

/clawsweeper re-review

jesse-merhi · 2026-05-08T14:48:32Z

/clawsweeper re-review

jesse-merhi · 2026-05-08T14:51:22Z

/clawsweeper re-review

jesse-merhi · 2026-05-11T03:03:14Z

/clawsweeper automerge

clawsweeper · 2026-05-11T03:25:12Z

🦞👀
ClawSweeper saw the passing review, but did not merge yet.

Source: clawsweeper[bot]
Feedback: structured ClawSweeper verdict: pass (sha=48e1ea1229561253124c2b3bc62b7c184ba91dc8)
Merge status: ClawSweeper pass marker targets a stale PR head SHA

I left the PR open for the remaining gate instead of bypassing it.

Automerge progress:

2026-05-11 08:04:19 UTC Codex write preflight (passed) in 33s Run: https://github.com/openclaw/clawsweeper/actions/runs/25657873471 danger-full-access

2026-05-11 08:04:22 UTC repair completed (no branch change) in 37s Run: https://github.com/openclaw/clawsweeper/actions/runs/25657873471 source PR Make exec command highlighting optional #79348 is paused by clawsweeper:human-review; refusing to mutate the PR branch

2026-05-11 08:04:24 UTC repair finished (blocked) in 39s Run: https://github.com/openclaw/clawsweeper/actions/runs/25657873471 source PR Make exec command highlighting optional #79348 is paused by clawsweeper:human-review; refusing to mutate the PR branch

2026-05-11 15:38:55 UTC review passed cfd1433665b1 (structured ClawSweeper verdict: pass (sha=cfd1433665b1362fc1984c1bd65575509ab24...)

2026-05-11 15:53:58 UTC repair queued cfd1433665b1 (autonomous) Run: https://github.com/openclaw/clawsweeper/actions/runs/25681197001

2026-05-11 15:56:33 UTC repair started (running) in 1s Run: https://github.com/openclaw/clawsweeper/actions/runs/25681197001 automerge-openclaw-openclaw-79348

2026-05-11 15:56:49 UTC validation plan (passed) in 17s Run: https://github.com/openclaw/clawsweeper/actions/runs/25681197001 pnpm check:changed; pnpm lint; pnpm check:test-types

2026-05-11 15:57:16 UTC Codex write preflight (passed) in 44s Run: https://github.com/openclaw/clawsweeper/actions/runs/25681197001 danger-full-access

2026-05-11 16:05:20 UTC Codex edit 1 07f957753e39 (complete) in 8m 48s Run: https://github.com/openclaw/clawsweeper/actions/runs/25681197001 exit 0

2026-05-11 16:11:23 UTC validation and review 1 3b30b44c96ef (base moved) in 14m 51s Run: https://github.com/openclaw/clawsweeper/actions/runs/25681197001 rebased

2026-05-11 16:11:29 UTC repair completed 3b30b44c96ef (branch updated) in 14m 57s Run: https://github.com/openclaw/clawsweeper/actions/runs/25681197001 initial automerge rebase is delegated to Codex repair

2026-05-11 16:11:28 UTC review queued 3b30b44c96ef (after repair)

2026-05-11 16:21:32 UTC automerge wait 3b30b44c96ef (waiting) in 25m Run: https://github.com/openclaw/clawsweeper/actions/runs/25681197001 waiting for exact-head ClawSweeper review pass

2026-05-11 16:21:34 UTC repair finished 3b30b44c96ef (pushed) in 25m 2s Run: https://github.com/openclaw/clawsweeper/actions/runs/25681197001 repair_contributor_branch

2026-05-11 16:23:57 UTC review queued 3b30b44c96ef (queued)

2026-05-11 17:20:46 UTC review passed 48e1ea122956 (structured ClawSweeper verdict: pass (sha=48e1ea1229561253124c2b3bc62b7c184ba91...)

clawsweeper · 2026-05-11T03:45:27Z

🦞🧹
ClawSweeper re-review requested.

I asked ClawSweeper to review this item again.
Action: item re-review queued (workflow sweep.yml, event repository_dispatch).
Result: the existing ClawSweeper review comment will be edited in place when the review finishes.

Re-review progress:

State: Complete
Detail: The targeted re-review finished, the durable review comment was updated, and the synced verdict was routed.
Run: https://github.com/openclaw/clawsweeper/actions/runs/25649181838
Updated: 2026-05-11T03:52:05.960Z

clawsweeper · 2026-05-11T06:59:53Z

🦞✅
ClawSweeper is pausing this repair loop for human review.

Source: clawsweeper[bot]
Reason: Review did not complete, so no work-lane recommendation was made. (sha=2c6c605bab522d09feccc21f04e163ac2cc7b41d)

I added clawsweeper:human-review and left the final call with a maintainer.

jesse-merhi · 2026-05-11T15:21:09Z

/clawsweeper automerge

clawsweeper · 2026-05-11T16:23:54Z

🦞✅
ClawSweeper is pausing this repair loop for human review.

Source: clawsweeper[bot]
Reason: Review did not complete, so no work-lane recommendation was made. (sha=3b30b44c96ef578c8f702ab10b91c322325b231b)

I added clawsweeper:human-review and left the final call with a maintainer.

clawsweeper · 2026-05-11T16:24:00Z

🦞🧹
ClawSweeper re-review requested.

I asked ClawSweeper to review this item again.
Action: item re-review queued (workflow sweep.yml, event repository_dispatch).
Result: the existing ClawSweeper review comment will be edited in place when the review finishes.

Re-review progress:

State: Failed
Detail: The targeted re-review did not finish cleanly. Check the workflow run for details.
Run: https://github.com/openclaw/clawsweeper/actions/runs/25682837150
Updated: 2026-05-11T16:36:20.067Z

openclaw-barnacle Bot added docs Improvements or additions to documentation gateway Gateway runtime agents Agent runtime and tooling size: S maintainer Maintainer-authored PR labels May 8, 2026

jesse-merhi marked this pull request as ready for review May 8, 2026 10:36

Copilot AI review requested due to automatic review settings May 8, 2026 10:36

Copilot started reviewing on behalf of jesse-merhi May 8, 2026 10:37 View session

Copilot AI reviewed May 8, 2026

View reviewed changes

Comment thread src/gateway/server-methods/server-methods.test.ts

jesse-merhi assigned steipete May 9, 2026

clawsweeper Bot added the clawsweeper:automerge Maintainer opted this PR into bounded ClawSweeper-reviewed automerge label May 11, 2026

clawsweeper Bot force-pushed the jesse/optional-command-highlighting branch from 0a44e7f to 132ab7a Compare May 11, 2026 03:42

clawsweeper Bot force-pushed the jesse/optional-command-highlighting branch from 132ab7a to 2c6c605 Compare May 11, 2026 06:47

clawsweeper Bot added the clawsweeper:human-review Needs maintainer review before ClawSweeper can continue label May 11, 2026

jesse-merhi force-pushed the jesse/optional-command-highlighting branch from 2c6c605 to cfd1433 Compare May 11, 2026 15:20

jesse-merhi requested a review from a team as a code owner May 11, 2026 15:20

openclaw-barnacle Bot added channel: mattermost Channel integration: mattermost channel: telegram Channel integration: telegram labels May 11, 2026

openclaw-barnacle Bot added channel: whatsapp-web Channel integration: whatsapp-web extensions: acpx extensions: nvidia size: M and removed size: S labels May 11, 2026

clawsweeper Bot removed the clawsweeper:human-review Needs maintainer review before ClawSweeper can continue label May 11, 2026

clawsweeper Bot force-pushed the jesse/optional-command-highlighting branch from cfd1433 to 3b30b44 Compare May 11, 2026 16:11

clawsweeper Bot added the clawsweeper:human-review Needs maintainer review before ClawSweeper can continue label May 11, 2026

jesse-merhi force-pushed the jesse/optional-command-highlighting branch from 3b30b44 to 6f3df30 Compare May 11, 2026 16:56

openclaw-barnacle Bot added size: S and removed channel: mattermost Channel integration: mattermost channel: telegram Channel integration: telegram channel: whatsapp-web Channel integration: whatsapp-web extensions: acpx extensions: nvidia size: M labels May 11, 2026

jesse-merhi force-pushed the jesse/optional-command-highlighting branch 2 times, most recently from dd386dd to 48e1ea1 Compare May 11, 2026 17:09

clawsweeper Bot removed the clawsweeper:human-review Needs maintainer review before ClawSweeper can continue label May 11, 2026

feat: make exec command highlighting optional

f625052

jesse-merhi force-pushed the jesse/optional-command-highlighting branch from 48e1ea1 to f625052 Compare May 11, 2026 17:44

jesse-merhi merged commit 79c2ed9 into main May 11, 2026
87 checks passed

jesse-merhi deleted the jesse/optional-command-highlighting branch May 11, 2026 17:59

clawsweeper Bot mentioned this pull request May 14, 2026

fix(config): add approvalRunningNoticeMs to ToolExecBaseShape #57293

Closed

9 tasks

github-actions Bot mentioned this pull request May 18, 2026

Update ghcr.io/openclaw/openclaw Docker tag to v2026.6.5 - autoclosed claytono/infra#2215

Closed

1 task

clawsweeper Bot mentioned this pull request Jun 30, 2026

test(config): add unit tests for resolveExecCommandHighlighting #98087

Merged

Uh oh!

Uh oh!

Conversation

jesse-merhi commented May 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Verification

Uh oh!

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

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

jesse-merhi commented May 8, 2026

Uh oh!

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

Uh oh!

Uh oh!

jesse-merhi commented May 8, 2026

Uh oh!

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

Uh oh!

Uh oh!

jesse-merhi commented May 8, 2026

Uh oh!

jesse-merhi commented May 8, 2026

Uh oh!

jesse-merhi commented May 8, 2026

Uh oh!

jesse-merhi commented May 11, 2026

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

clawsweeper Bot commented May 11, 2026

Uh oh!

jesse-merhi commented May 11, 2026

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jesse-merhi commented May 8, 2026 •

edited

Loading

clawsweeper Bot commented May 8, 2026 •

edited

Loading

clawsweeper Bot commented May 8, 2026 •

edited

Loading

clawsweeper Bot commented May 8, 2026 •

edited

Loading

clawsweeper Bot commented May 11, 2026 •

edited

Loading

clawsweeper Bot commented May 11, 2026 •

edited

Loading

clawsweeper Bot commented May 11, 2026 •

edited

Loading

clawsweeper Bot commented May 11, 2026 •

edited

Loading