docs: consolidate global CLI options + document OpenVEX generation#93
Merged
Mikola Lysenko (mikolalysenko) merged 1 commit intoMay 29, 2026
Merged
Conversation
Move the flags that clap flattens into every subcommand into a single "Global Options" section (with env vars and precedence), and trim each command's table down to its command-specific flags. Also fixes a few stale entries (no `-d` short for `--dry-run`, repair's download-mode default is `diff` not `file`) and documents the previously-undocumented `--all-releases`, `--proxy-url`, `--lock-timeout`, `--break-lock`, `--debug`, and `--no-telemetry` flags. Adds a `vex` command entry and an "OpenVEX attestations" section covering product auto-detection, output channels, and how to feed the document into Grype/Trivy/vexctl. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Wenxin Jiang (Wenxin-Jiang)
approved these changes
May 29, 2026
Mikola Lysenko (mikolalysenko)
deleted the
docs/readme-global-options-and-openvex
branch
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
2 participants
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.
Summary
README-only refactor in two parts, as requested:
Common global arguments moved to the top. Added a
## Global Optionssection (after Quick Start) listing the flags clap flattens into every subcommand, with theirSOCKET_*env vars and the CLI > env > default precedence. Each command's options table is trimmed down to its command-specific flags only, prefaced with a pointer to Global Options.OpenVEX generation documented. Added a
### vexcommand entry and a dedicated## OpenVEX attestationssection covering what it does, product auto-detection order, the three output channels (and why--jsonrequires--output), and how to feed the document into Grype/Trivy/vexctl.Incidental corrections
While consolidating, the per-command tables were reconciled against the actual
GlobalArgs/command structs:-dshort for--dry-run(no such short flag exists).repair's--download-modedefault isdiff(the global default), notfile.--proxy-url,--lock-timeout,--break-lock,--debug,--no-telemetry, and the--all-releasescommand flag onget/scan.No source code changed — docs only.
🤖 Generated with Claude Code