Skip to content

docs: add --create-pr, --base, and --debug flags to CLI reference - #998

Open
Kakashi15-pix wants to merge 1 commit into
OWASP:mainfrom
Kakashi15-pix:feature/issue-993-cli-reference-flags
Open

docs: add --create-pr, --base, and --debug flags to CLI reference#998
Kakashi15-pix wants to merge 1 commit into
OWASP:mainfrom
Kakashi15-pix:feature/issue-993-cli-reference-flags

Conversation

@Kakashi15-pix

Copy link
Copy Markdown

What changed and why

Adds the three CLI flags (--create-pr, --base <branch>, --debug) that
appear in cve-lite --help but were missing from the CLI reference docs.
Descriptions are worded to match the help strings in src/cli/help.ts
(lines 45-50), and each row follows the existing table format with a
default value and example command.

Verified npm run build completes with no broken-link errors and the
new rows render correctly in the CLI reference page.

Closes #993

@sonukapoor

Copy link
Copy Markdown
Collaborator

Thanks for this, and the descriptions themselves are accurate. A few table things before it goes in:

  • The --batch-size row above lost its trailing | (and the blank line after it) in this diff. Let's leave that row untouched and just add the new rows below it.
  • On the new rows: the --base description repeats "(default:'main')", which the Default column already shows, so we can drop that; gh reads better as `gh` than in single quotes; there's a double space in "Base branch for"; and a couple of trailing spaces to trim.
  • Minor: a less arbitrary example than developer_test, maybe develop.

Content is spot on, just tidy the table and it's good to go.

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.

docs: document --base, --create-pr, and --debug in the CLI reference

2 participants