Skip to content

Commit 1c4555d

Browse files
authored
🤖 fix: clarify run_and_report output handling guidance (#42)
Summary Updated AGENTS.md to explicitly forbid wrapping, redirecting, piping, prepending, or appending output when invoking `run_and_report`. This keeps helper step markers readable in the Mux UI. Background The helper already handles logging, context control, and pass/fail marker output. Additional shell wrapping around its output makes human review harder in the Mux UI. Implementation - Added a direct instruction under **Mux Tooling Helpers** to invoke `run_and_report` directly with no output wrapping. - Added a matching **Anti-patterns** entry to reinforce the same rule in a second high-signal section. Validation - `run_and_report verify-vendor make verify-vendor` - `run_and_report test make test` - `run_and_report build make build` - `run_and_report lint make lint` Risks Low risk. This is guidance-only documentation and does not change runtime behavior. --- _Generated with [`mux`](https://github.com/coder/mux) • Model: `openai:gpt-5.3-codex` • Thinking: `xhigh` • Cost: `$0.39`_ <!-- mux-attribution: model=openai:gpt-5.3-codex thinking=xhigh costs=0.39 -->
1 parent a26a198 commit 1c4555d

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

‎AGENTS.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ Run from repository root.
8787
- `.mux/tool_env` is sourced before every `bash` tool call (Mux docs: `/hooks/tools`).
8888
- Use `run_and_report <step_name> <command...>` for multi-step validation in one bash invocation.
8989
- The helper writes full logs to `/tmp/mux-<workspace>-<step>.log`, prints pass/fail markers, and tails failures.
90+
- Do not pipe, redirect, prepend, append, or otherwise wrap `run_and_report` output. Invoke it directly so the helper’s step markers remain human-readable in the Mux UI.
9091
- Example:
9192
- `run_and_report verify-vendor make verify-vendor`
9293
- `run_and_report test make test`
@@ -113,6 +114,7 @@ Run from repository root.
113114
- Unpinned GitHub Action versions in workflow files (CI uses SHA-pinned actions).
114115
- Running CI-sensitive commands without vendoring mode when behavior differs from CI.
115116
- Removing assertion messages that start with `assertion failed:`; these are deliberate diagnostics.
117+
- Wrapping `run_and_report` output with shell redirection/pipes or extra surrounding text; this obscures the helper’s built-in markers in the Mux UI.
116118

117119
## Code Style
118120

0 commit comments

Comments
 (0)