docs: fix README CLI flags table - #11
Merged
Merged
Conversation
- Separate global flags from scan-specific flags - Add missing flags: --json-top-n, --debug/-d, --no-cleanup - Fix --top-n description: 'per language per base OS' (not just 'per language') - Correct flag scoping (--top-n, --verbose etc. are global, not scan-only) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Mani Bindra (maniSbindra)
requested a review
from Dariusz Porowski (DariuszPorowski)
as a code owner
April 17, 2026 14:13
There was a problem hiding this comment.
Pull request overview
Updates the README’s CLI flags documentation so it reflects the current Cobra --help output and correctly distinguishes between persistent (global) flags and scan-specific flags.
Changes:
- Split the CLI flags table into Global vs
scansections. - Added missing documented flags:
--json-top-n,--debug/-d,--no-cleanup. - Corrected/clarified flag descriptions (notably
--top-nsemantics).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Member
Author
|
Copilot please review |
Contributor
The PR looks good. All flag descriptions in the README match the actual CLI |
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.
Summary
Fixes the CLI flags table in README.md which was outdated and incomplete.
Changes
--top-n,--verbose,--databaseare global (available on all subcommands), not scan-only--json-top-n,--debug/-d,--no-cleanup--top-ndescription: ranked per language per base OS, not just per language--helpoutput