Skip to content

docs: missing CLI flags in README - #7596

Merged
dwisiswant0 merged 1 commit into
devfrom
7595-readme-flags
Jul 26, 2026
Merged

docs: missing CLI flags in README#7596
dwisiswant0 merged 1 commit into
devfrom
7595-readme-flags

Conversation

@Mzack9999

@Mzack9999 Mzack9999 commented Jul 25, 2026

Copy link
Copy Markdown
Member

Add six flags that are registered in the CLI but were missing from the README help block (and all locale copies):

  • -targets-inline (TARGET)
  • -vtt / -vars-text-templating, -vfp / -var-file-paths (TARGET-FORMAT)
  • -pe / -pdf-export (OUTPUT)
  • -per-host-rate-limit (RATE-LIMIT)
  • -preflight-portscan (OPTIMIZATIONS)

Closes #7595

Summary by CodeRabbit

  • Documentation
    • Updated CLI help documentation across supported languages.
    • Added guidance for inline multiline targets, variable templating and YAML injection.
    • Documented PDF result export and per-host rate limiting.
    • Added details for optional pre-scan TCP port filtering before scanning.

@coderabbitai

coderabbitai Bot commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

The README files now document six CLI flags across target input, variable handling, PDF output, rate limiting, and preflight target filtering sections in English and localized translations.

Changes

CLI help documentation

Layer / File(s) Summary
Target and variable flags
README*.md
Documents inline multiline targets plus variable templating and YAML variable-file injection options.
Output and rate-limit flags
README*.md
Documents PDF result export and per-host rate limiting.
Preflight scanning flag
README*.md
Documents optional preflight resolution and TCP port scanning before target filtering and scanning.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Poem

I’m a rabbit with docs in my paws,
Adding flags without bugs or applause.
Targets hop in line,
PDFs now shine,
And scans preflight through the claws!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The README updates add all six missing CLI flags across the documented locale files, matching the linked issue requirements.
Out of Scope Changes check ✅ Passed The changes stay within documentation and localization updates, with no unrelated code or behavior changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding missing CLI flags to the README documentation.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 7595-readme-flags

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@Mzack9999 Mzack9999 changed the title docs: sync README help with missing CLI flags readme flags Jul 25, 2026
@dwisiswant0 dwisiswant0 changed the title readme flags docs: missing CLI flags in README Jul 26, 2026
@dwisiswant0
dwisiswant0 merged commit 63bfe19 into dev Jul 26, 2026
3 checks passed
@dwisiswant0
dwisiswant0 deleted the 7595-readme-flags branch July 26, 2026 04:27
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.

[BUG] README help output is missing six flags registered in the CLI

2 participants