GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — docs: consolidate global CLI options + document OpenVEX generation by mikolalysenko · Pull Request #93 · SocketDev/socket-patch

Conversation

@mikolalysenko

@mikolalysenko Mikola Lysenko (mikolalysenko) commented May 29, 2026

Copy link
Copy Markdown
Collaborator

Summary

README-only refactor in two parts, as requested:

  1. Common global arguments moved to the top. Added a ## Global Options section (after Quick Start) listing the flags clap flattens into every subcommand, with their SOCKET_* 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.

  2. OpenVEX generation documented. Added a ### vex command entry and a dedicated ## OpenVEX attestations section covering what it does, product auto-detection order, the three output channels (and why --json requires --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:

  • Dropped the bogus -d short for --dry-run (no such short flag exists).
  • repair's --download-mode default is diff (the global default), not file.
  • Documented previously-undocumented global flags: --proxy-url, --lock-timeout, --break-lock, --debug, --no-telemetry, and the --all-releases command flag on get/scan.

No source code changed — docs only.

🤖 Generated with Claude Code

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@mikolalysenko @claude
docs: consolidate global CLI options + document OpenVEX generation
895684d 
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) <[email protected]>
@mikolalysenko
Mikola Lysenko (mikolalysenko) enabled auto-merge (squash) May 29, 2026 17:33
Wenxin-Jiang
Wenxin Jiang (Wenxin-Jiang) approved these changes May 29, 2026
View reviewed changes
@mikolalysenko
Mikola Lysenko (mikolalysenko) merged commit a235410 into main May 29, 2026
42 checks passed

Uh oh!

There was an error while loading. Please reload this page.
@mikolalysenko
Mikola Lysenko (mikolalysenko) deleted the docs/readme-global-options-and-openvex branch May 29, 2026 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Wenxin-Jiang Wenxin Jiang (Wenxin-Jiang) Wenxin-Jiang approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@mikolalysenko @Wenxin-Jiang
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.