Skip to content

docs(cli): describe --timeout, --processes and --quiet in scan --help - #1451

Merged
mstykow merged 1 commit into
mainfrom
docs/cli-help-timeout-processes-quiet
Oct 11, 2026
Merged

mstykow merged 1 commit into
mainfrom
docs/cli-help-timeout-processes-quiet

Conversation

@mstykow

@mstykow mstykow commented Oct 11, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • provenant scan --help showed --timeout, --processes and --quiet with no description. docs/CLI_GUIDE.md defers to scan --help for the full flag surface, so this is where they should be documented.
  • Adds help text for the three flags, including what happens to a file that exceeds --timeout (reported in scan_errors, scan continues) and how 0 / -1 change the behavior.

Scope and exclusions

  • Included: doc comments on three clap args in src/cli/mod.rs.
  • Explicit exclusions: no behavior change; no other docs touched.

How to verify

  • provenant scan --help and read the --processes, --timeout and --quiet entries.

🤖 Generated with Claude Code

@greptile-apps

greptile-apps Bot commented Oct 11, 2026 •

Copy link
Copy Markdown

RetriggerConfidence Score: 5/5

[Low impact] The PR appears safe to merge; both previous wording issues are fixed.

Summary

Adds help text for --processes, --timeout, and --quiet without changing scan behavior.

  • Scan help explains how three scan flags behave.

Reviews (2) · Last reviewed commit: "docs(cli): describe --timeout, --process..." · Reviewed by Greptile

Comment thread src/cli/mod.rs Outdated
Comment thread src/cli/mod.rs Outdated
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Signed-off-by: Maxim Stykow <maxim.stykow@gmail.com>
@mstykow
mstykow force-pushed the docs/cli-help-timeout-processes-quiet branch from 422d349 to 6eca4f3 Compare October 11, 2026 04:15
@mstykow
mstykow merged commit db2d498 into main Oct 11, 2026
13 checks passed
@mstykow
mstykow deleted the docs/cli-help-timeout-processes-quiet branch October 11, 2026 05:37
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.

1 participant