Skip to content

Commit 062e688

Browse files
Docs: Update README with security scrubbing feature
1 parent eacc47c commit 062e688

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,25 @@ Looking to contribute? Check out:
3333
📋 **Auto-Copy to Clipboard** - Generated messages are automatically copied for instant use
3434
🎛️ **Interactive Review Flow** - Accept, regenerate with new styles, or open the message in your editor before committing
3535
📊 **File Statistics Display** - Visual preview of changed files and line counts
36-
🚀 **Easy to Use** - Simple CLI interface with beautiful terminal UI
36+
**Smart Security Scrubbing** - Automatically removes API keys, passwords, and sensitive data from diffs
37+
�🚀 **Easy to Use** - Simple CLI interface with beautiful terminal UI
3738
**Fast** - Quick generation of commit messages
3839

3940
## Supported LLM Providers
4041

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

44+
## 🔒 Security & Privacy
45+
46+
`commit-msg` automatically scrubs sensitive data from your code before sending it to LLM providers:
47+
48+
- **API Keys & Tokens** - OpenAI, Gemini, Claude, GitHub, Slack, AWS credentials
49+
- **Passwords & Secrets** - Database passwords, JWT tokens, private keys
50+
- **Personal Data** - Email addresses, credit card numbers
51+
- **Environment Variables** - Automatic detection and redaction of sensitive `.env` files
52+
53+
All scrubbing happens locally before any data leaves your machine, ensuring your secrets stay secure.
54+
4355
---
4456

4557
## 📦 Installation

0 commit comments

Comments
 (0)