Skip to content

Docs: Update README with security scrubbing feature #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DFanso merged 2 commits into from
Oct 7, 2025
Merged

Docs: Update README with security scrubbing feature #79

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
062e688
Docs: Update README with security scrubbing feature
vinyas-bharadwaj Oct 7, 2025
effa39b
Merge branch 'DFanso:main' into main
vinyas-bharadwaj Oct 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,25 @@ Looking to contribute? Check out:
📋 **Auto-Copy to Clipboard** - Generated messages are automatically copied for instant use
🎛️ **Interactive Review Flow** - Accept, regenerate with new styles, or open the message in your editor before committing
📊 **File Statistics Display** - Visual preview of changed files and line counts
🚀 **Easy to Use** - Simple CLI interface with beautiful terminal UI
� **Smart Security Scrubbing** - Automatically removes API keys, passwords, and sensitive data from diffs
�🚀 **Easy to Use** - Simple CLI interface with beautiful terminal UI
Comment on lines +36 to +37
Copy link
Contributor

@coderabbitai coderabbitai bot Oct 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix the garbled bullet characters.

Line 36 and Line 37 now show the Unicode replacement glyph (�) instead of the intended emoji/bullet, so the rendered feature list looks broken. Please restore the proper characters (e.g., 🎯 or •) before merging.

🤖 Prompt for AI Agents 
In README.md around lines 36 to 37 the bullet/emoji characters are showing the
Unicode replacement glyph (�); replace the garbled characters with valid Unicode
bullets or emojis (for example "🎯" or "•" for line 36 and "🚀" or "•" for line
37) and ensure the file is saved with UTF-8 encoding so the characters render
properly across environments.

⚡ **Fast** - Quick generation of commit messages

## Supported LLM Providers

You can use **Google Gemini**, **Grok**, **Claude**, **ChatGPT**, or **Ollama** (local) as the LLM to generate commit messages:

## 🔒 Security & Privacy

`commit-msg` automatically scrubs sensitive data from your code before sending it to LLM providers:

- **API Keys & Tokens** - OpenAI, Gemini, Claude, GitHub, Slack, AWS credentials
- **Passwords & Secrets** - Database passwords, JWT tokens, private keys
- **Personal Data** - Email addresses, credit card numbers
- **Environment Variables** - Automatic detection and redaction of sensitive `.env` files

All scrubbing happens locally before any data leaves your machine, ensuring your secrets stay secure.

---

## 📦 Installation
Expand Down
Loading