docs: correct two CLI facts in AGENTS.md - #5573
Open
jimparkins wants to merge 1 commit into
Open
Conversation
Both verified against crates/buzz-cli/src/commands/messages.rs at be48ce9. `messages search` has no --kinds flag. It hardcodes an explicit kind filter (messages.rs:451), so the documented failure — an open-ended search hitting the relay p-gate — cannot occur, and the documented fix is an unrecognized-argument error. `messages get` is the subcommand that accepts --kinds (messages.rs:359, default at :366), which is the likely origin of the confusion. The deep-link example trailed `--format compact` after the subcommand, contradicting the correct statement 14 lines below it that --format is global. Found while building an out-of-tree buzz-backend-* provider; the search line sent me looking for a flag that does not exist. Signed-off-by: Jim Parkins <jimparkins@gmail.com>
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
1 participant
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.
Two factual corrections to the agent guide, both verified against
crates/buzz-cli/src/commands/messages.rsatbe48ce9.1.
messages searchhas no--kindsflagGotcha 3 currently says an open-ended search hits the relay p-gate and to pass
--kindsto scope it. Neither half holds:searchhardcodes an explicit kind filter —"kinds": [9, 40002, 45001, 45003]atmessages.rs:451— so the documented failure cannot occur.--kindsargument on the subcommand, so the documented fix is an unrecognized-argument error.messages getis the subcommand that accepts--kinds(messages.rs:359, default[9, 40002, 40008, 45001, 45003]at:366), which is the likely origin of the confusion. The replacement text says so, since that is the question a reader arrives with.2. The deep-link example contradicts the rule 14 lines below it
The example trails
--format compactafter the subcommand:while the guide states correctly a few lines later that
--format compactis a global flag that goes before the subcommand. Reordered to match.Found while building an out-of-tree
buzz-backend-*provider that runs Buzz agents in Orca worktrees — the search line sent me looking for a flag that does not exist.Note the edit is to
AGENTS.md;CLAUDE.mdis a symlink to it.