Skip to content

docs: add missing command help docs#6893

Open
fsargent wants to merge 2 commits into
snyk:mainfrom
fsargent:docs/help-audit-command-docs
Open

docs: add missing command help docs#6893
fsargent wants to merge 2 commits into
snyk:mainfrom
fsargent:docs/help-audit-command-docs

Conversation

@fsargent

@fsargent fsargent commented Jun 9, 2026

Copy link
Copy Markdown

Pull Request Submission Checklist

  • Follows CONTRIBUTING guidelines
  • Commit messages are release-note ready, emphasizing what was changed, not how.
  • Includes detailed description of changes
  • Contains risk assessment (Low | Medium | High)
  • Highlights breaking API changes (if applicable)
  • Links to automated tests covering new functionality
  • Includes manual testing instructions (if necessary)
  • Updates relevant GitBook documentation (PR link: this PR updates synced CLI help docs)
  • Includes product update to be announced in the next stable release notes

What does this PR do?

Stacked on #6892.

Adds help pages for visible CLI commands identified by npm run help:audit, including about, agent-scan, fix, iac rules repl, redteam subcommands, secrets test, tools diagnostics, and version.

It also excludes command entries that should not require standalone help pages: implementation-only aliases, deprecated stubs, legacy unmanaged mode aliases, and internal helper workflows.

Risk assessment: Low. Documentation-only plus help-audit classification.

Breaking API changes: None.

Where should the reviewer start?

Start with scripts/audit-cli-help-docs.js for the exclusion list, then review the new files in help/cli-commands/.

How should this be manually tested?

Run:

npm run help:audit -- --fail-on-missing

Validation already run locally:

make format
make lint
make build BUILD_MODE=public
npm run help:audit -- --fail-on-missing

What's the product update that needs to be communicated to CLI users?

CLI help coverage has been expanded for additional visible commands.

@fsargent fsargent requested a review from a team as a code owner June 9, 2026 20:15
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@snyk-io

snyk-io Bot commented Jun 9, 2026

Copy link
Copy Markdown

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants