docs(schema): document the options the CLI already accepts - #491
docs(schema): document the options the CLI already accepts#491boleklebovski wants to merge 1 commit into
Conversation
pr-reviewer Summary for #1aee8cb✅ No issues found The code review completed successfully with no findings. Review effort: 2/5 (Simple) SummaryThis PR is a clean schema sync — it adds 94 previously-missing option entries to I verified every addition against the source:
Token usage: 2,156 input, 5,218 output, 750,445 cache read, 51,313 cache write | Usage Guide New pushes are reviewed automatically with a 10-minute cooldown between reviews. To request a review at any time, comment |
There was a problem hiding this comment.
Auto-approved
This PR was automatically approved because:
- Claude recommends approval
- Claude assessed this as a moderate effort change
- The effort level is within the auto-approval threshold of 2
- No high or critical issues were detected
- Review comment contains non-blocking feedback
If you have any concerns, please request a manual review.
7ef9283 to
da9b5c3
Compare
There was a problem hiding this comment.
Auto-approved
This PR was automatically approved because:
- Claude recommends approval
- Claude assessed this as a moderate effort change
- The effort level is within the auto-approval threshold of 2
- No high or critical issues were detected
If you have any concerns, please request a manual review.
The machine-readable schema was missing the 42 type-specific alerts flags, the seven `alerts list` filters, `--addresses`/`--file` on `research profiler batch` and `--search` on `research token screener`. All are already read by the command implementations. Signed-off-by: boleklebovski <160799963+boleklebovski@users.noreply.github.com>
da9b5c3 to
1aee8cb
Compare
There was a problem hiding this comment.
Auto-approved
This PR was automatically approved because:
- Claude recommends approval
- Claude assessed this as a moderate effort change
- The effort level is within the auto-approval threshold of 2
- No high or critical issues were detected
If you have any concerns, please request a manual review.
Problem
src/schema.jsonis the machine-readable description of the CLI surface, but several groups of options that the code already implements are missing from it. Anything that consumes the schema (shell completions, the MCP surface,--helptooling, docs generation) therefore cannot see them.Concretely, on
mainthe schema is missing:alerts createalerts updatealerts listoptionskey at all)research profiler batchresearch token screenerEvidence
The 42 type-specific alert flags are built in
src/commands/alerts.js— e.g.buildSmTokenFlowsData()iterates aflowFieldslist and readsoptions['<field>-min']/options['<field>-max']for each ofinflow-1h/1d/7d,outflow-1h/1d/7d,netflow-1h/1d/7d:The
alerts listhandler reads exactlyflags.enabled,flags.disabled,options.type,options['token-address'],options.chain,options.offsetandoptions.limit— none of which were described.Change
Adds the missing option entries only. No option is renamed, removed or re-typed; no runtime code is touched. The additions were derived from the command implementations themselves (the alert set matches the code's own
typeSpecificFlagstable entry-for-entry), so nothing here is invented.Verification
src/schema.jsonparses, has no duplicate keys, keeps 2-space indentation and the existing key ordering.src/**/*.js.A changeset is included (
patch).