docs: document --runtime flag for gh aw logs and gh aw audit - #52076
Merged
pelikhan merged 2 commits intoAug 11, 2026
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix documentation gap for --runtime flag in CLI
docs: document --runtime flag for gh aw logs and gh aw audit
Aug 11, 2026
pelikhan
marked this pull request as ready for review
August 11, 2026 15:23
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Pull request overview
Documents the existing --runtime filtering flag for the logs and audit commands.
Changes:
- Adds --runtime to both commands’ option lists.
- Adds gVisor filtering examples.
| File | Description |
|---|---|
| docs/src/content/docs/setup/cli.md | Documents runtime filtering for logs and audits. |
Review details
Tip
Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
docs/src/content/docs/setup/cli.md:546
- This non-stdin example is placed in the --stdin flag's example block, which misleadingly associates --runtime with stdin input. Document it in a separate flag subsection (or move it to the general audit examples) instead.
gh aw audit 1234567890 --runtime gvisor # Skip run unless sandbox agent runtime matches
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Balanced
Sorry, something went wrong.
Comment thread
docs/src/content/docs/setup/cli.md
| cat run-ids.txt | gh aw logs --stdin | ||
| echo "1234567890" | gh aw logs --stdin --engine claude | ||
| cat run-ids.txt | gh aw logs --stdin --repo owner/repo # required for bare numeric IDs | ||
| gh aw logs --runtime gvisor # Filter to runs using a specific sandbox agent runtime |
Copy link
Copy Markdown
Contributor
|
🎉 This pull request is included in a new release. Release: v0.86.2 |
Sorry, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The CLI consistency checker found that --runtime — a real, working flag on both gh aw logs and gh aw audit used to filter runs by sandbox agent runtime (e.g., gvisor, docker-sbx) — was completely absent from docs/src/content/docs/setup/cli.md.
Changes