Skip to content

Update README formatting and CLI help output#4758

Open
bryanbeverly wants to merge 2 commits intomainfrom
update-readme-formatting
Open

Update README formatting and CLI help output#4758
bryanbeverly wants to merge 2 commits intomainfrom
update-readme-formatting

Conversation

@bryanbeverly
Copy link

@bryanbeverly bryanbeverly commented Feb 22, 2026

Summary

  • Remove leading $ prompt characters from example bash commands (lines 264, 269) for easier copy-paste
  • Replace outdated trufflehog git --help output with current CLI flags and subcommands

Test plan

  • Verify README renders correctly on GitHub
  • Confirm CLI help output matches current binary behavior

Simplify HTML markup to plain markdown, update the git --help output
to reflect current flags and subcommands, and fix minor formatting
inconsistencies.

Co-authored-by: Cursor <cursoragent@cursor.com>
@bryanbeverly bryanbeverly requested a review from a team February 22, 2026 23:07
Remove leading $ from example commands and replace outdated
trufflehog git --help output with current CLI flags and subcommands.

Co-authored-by: Cursor <cursoragent@cursor.com>
@rosecodym
Copy link
Contributor

Thanks for this! How did the test plan go? (I ask because the boxes are still unchecked.)

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