🛡️ NGC CommitGuard

Stop Committing Secrets to Git - Your last line of defense against accidental credential leaks

NextGenCode - www.nextgencode.dev

🎯 What Is This?

NGC CommitGuard is a VS Code extension that blocks commits containing secrets like API keys, passwords, and tokens. Think of it as your vigilant security guard that never sleeps.

Watch It In Action

Interactive menu when secrets detected during commit

🚀 Why NGC CommitGuard?

Better than manual checks. Smarter than regex. Easier than Husky.

✨ What Makes It Special

• 🔍 21+ Detection Patterns (PRO) - AWS, Google Cloud, GitHub tokens, Stripe keys, JWT, database URLs, and more
• ⚡ Real-Time Protection - Scans files as you save them
• 🎯 Zero Configuration - Works instantly after install
• 🔒 Git Hook Integration - Automatically blocks dangerous commits
• 💬 Interactive Menu - Choose how to handle each detection
• 🎨 Beautiful Dashboard - See stats and license details
• 💰 One-Time Payment - $49 lifetime or $19/year, no subscriptions
• 🔐 100% Offline - RSA licensing, zero telemetry, your code never leaves your machine

📦 Installation

From VS Code Marketplace (Coming Soon)

1. Open VS Code Extensions (Ctrl+Shift+X)
2. Search for "NGC CommitGuard"
3. Click Install
4. Reload window if prompted

Manual Installation

�️ PRO

🎯 PRO Patterns Include:

// test.js
const apiKey = "AKIAIOSFODNN7EXAMPLE";

🔒 Upgrade to PRO →

• AWS, Google Cloud, Azure credentials
• GitHub, GitLab, Bitbucket tokens
• Stripe, PayPal, Twilio API keys
• Database connection strings
• Private keys (RSA, SSH)
• JWT tokens
• Credit card numbers
• And much more!
• 🎨 Custom patterns - Add your own regex patterns
• 📊 Advanced statistics and security reports
• 💜 Support independent development

🔒 Upgrade to PRO - Just 5 PLN, lifetime license!

🎯 Quick Start

1. Automatic Protection

NGC CommitGuard works automatically! Just save your files, and it will scan them in real-time.

2. Manual Scan

• Press Ctrl+Shift+P / Cmd+Shift+P
• Type: NGC: Scan Workspace
• View results in the sidebar

3. Activate PRO (Optional)

• Press Ctrl+Shift+P / Cmd+Shift+P
• Type: NGC: Activate PRO License
• Enter your license key

⚙️ Configuration

The extension works out of the box, but you can customize it:

Settings (Ctrl+, → Search "NGC CommitGuard"):

{
  // Enable/disable extension
  "ngc-commitguard.enabled": true,
  
  // Exclude directories from scanning
  "ngc-commitguard.excludePatterns": [
    "**/node_modules/**",
    "**/dist/**",
    "**/.git/**"
  ],
  
  // PRO ONLY: Custom detection patterns
  "ngc-commitguard.customPatterns": [
    {
      "name": "Company API Key",
      "pattern": "MYAPP_[A-Z0-9]{32}",
      "severity": "high",
      "description": "Internal API key format"
    }
  ]
}

Per-Workspace Settings:

Create .vscode/settings.json in your project:

{
  "ngc-commitguard.excludePatterns": [
    "tests/fixtures/**"
  ]
}

See docs/USER_GUIDE.md for full configuration options.

🎨 Screenshots

Dashboard & Statistics

FREE version dashboard with scan statistics and upgrade options

Git Hook Blocking

Interactive menu with 5 options when secrets detected during commit

Command Palette

All NGC CommitGuard commands accessible via Command Palette

Upgrade Options

Quick access to all pricing tiers with discount codes

Lifetime (€79) and Annual (€49) plans with feature comparison

� Documentation

• User Guide - Installation, activation, features, troubleshooting
• Development Guide - Build, test, contribute, architecture
• Changelog - Version history and updates

Helpful Links

• GitHub: Mattzey/ngc-commitguard
• Issues: Report a bug
• Support: nextgencode.dev/#contact
• Purchase PRO: nextgencode.dev/commitguard/pricing | Manually scan all files in workspace | | NGC: Scan Current File | Scan only the currently open file | | NGC: Activate PRO License | Enter your PRO license key | | NGC: View License Info | Show license details (PRO only) | | NGC: Upgrade to PRO | View pricing and purchase options | | NGC: Manage Whitelist | Add/remove whitelist entries | | NGC: Clear Whitelist | Remove all whitelist entries |

Tip: Type "NGC" in command palette to see all commands

📱 Other

• Credit Card Numbers
• Email + Password combinations
• IP Addresses
• Generic OAuth secrets

🚀 How It Works

Real-Time File Scanning

1. You save a file → Extension scans immediately
2. Secret detected → Notification appears
3. You decide → Fix it or whitelist it

Git Commit Protection

1. You run git commit → Pre-commit hook activates
2. Staged files scanned → All changes checked
3. Secret found → Interactive menu appears:

🛡️ NGC CommitGuard - Secrets Detected!

Found 2 secret(s) in 1 file(s)

What would you like to do?

[1] 🚫 Ignore Once - Commit anyway (DANGEROUS)
[2] ✅ Add to Whitelist - Always allow this
[3] 🔄 Edit Files - Fix the issue now
[4] 📋 View in VS Code - Open detections panel
[5] ❌ Abort Commit - Cancel and review (RECOMMENDED)

Your choice [1-5]:

4. You choose option 5 → Commit blocked, you're safe!

Whitelist Management

When to use whitelist:

• Test data that looks like secrets (but isn't)
• Example code in documentation
• Public demo credentials
• False positives

Whitelist file: .ngc-whitelist.json in your repo root

{
  "version": "1.0",
  "entries": [
    {
      "type": "file",
      "path": "examples/demo.js",
      "reason": "Fake secrets for documentation"
    }
  ]
}

Tip: Commit .ngc-whitelist.json to share with your team! { "type": "file", "file": "tests/fixtures/credentials.json", "reason": "Test fixture" } ] }

#### Whitelist Commands:
- `NGC: Manage Whitelist` - View, edit, import/export
- `NGC: Clear Whitelist` - Remove all entries (with confirmation)

See [docs/whitelist-example.json](https://github.com/Mattzey/ngc-commitguard/blob/HEAD/docs/whitelist-example.json) for a complete example.

---

## 🎯 Use Cases

### 1. **Individual Developers**
- Protect personal projects from accidental leaks
- Learn security best practices
- Affordable one-time payment

### 2. **Teams & Enterprises**
- Enforce security policies across the team
- Custom patterns for internal secrets
- Prevent costly data breaches

### 3. **Open Source Projects**
- Keep your public repos clean
- Protect contributor credentials
- Professional security validation

---

## 🤝 Why Choose NGC CommitGuard?

| Feature | NGC CommitGuard | Husky | Other Tools |
|---------|----------------|-------|-------------|
| **VS Code Integration** | ✅ Native | ❌ | ⚠️ Limited |
| **Real-time Scanning** | ✅ | ❌ | ⚠️ Limited |
| **Visual Interface** | ✅ Beautiful | ❌ | ⚠️ Basic |
| **Zero Config** | ✅ | ❌ Requires setup | ⚠️ Varies |
| **Custom Patterns** | ✅ PRO | ❌ | ⚠️ Complex |
| **Cross-platform** | ✅ | ✅ | ⚠️ Varies |
| **Pricing** | 💰 5 PLN lifetime | Free | 💰💰 Expensive |

---

## � Why Not Just Use Husky?

| Feature | NGC CommitGuard | Husky + Manual Scripts |
|---------|-----------------|------------------------|
| **SePerfect For

### 🧑‍💻 Individual Developers
- Protect side projects and portfolios
- Learn security best practices
- One-time payment, use forever

### 👥 Teams & Enterprises
- Enforce security policies across team
- Add custom patterns for internal secrets
- Prevent costly data breaches
- Share whitelist with `.ngc-whitelist.json`

### 🌍 Open Source Maintainers
- Keep public repos clean
- Protect contributor credentials
- Professional commit validation
- Build trust with contributors

🔒 Privacy & Security

• 100% Local - All scanning happens on your machine
• No Data Sent - Your code never leaves VS Code
• Open Source - Transparent and auditable
• License Validation - Minimal API call (license key only)

🌟 Support & Feedback

• 🐛 Bug Reports: GitHub Issues
• 💡 Feature Requests: GitHub Discussions
• 📧 Email: mattemzet@gmail.com
• 🌐 Website: www.nextgencode.dev

💜 Support Development

NGC CommitGuard is developed and maintained by NextGenCode. If you find it useful, consider:

1. ⭐ Star the repository
2. 🔒 Upgrade to PRO (5 PLN - lifetime)
3. 📣 Share with your team
4. ✍️ Write a review on VS Code Marketplace

📝 License

MIT License - See LICENSE file for details �️ For Developers

� Support & Feedback

Need Help?

• 📖 User Guide: docs/USER_GUIDE.md
• 🐛 Bug Reports: GitHub Issues
• 💡 Feature Requests: GitHub Discussions
• 📧 Email Support: nextgencode.dev/#contact
• 🌐 Website: nextgencode.dev This Project

NGC CommitGuard is built and maintained by NextGenCode. If you find it useful:

1. ⭐ Star this repo on GitHub
2. 🛡️ Upgrade to PRO - $49 lifetime, supports continued development
3. 📣 Share with your team - Help others avoid credential leaks
4. ✍️ Write a review - Feedback helps improve the extension
5. 🐛 Report bugs - Make it better for everyone

Every PRO license helps fund:

• 🚀 New detection patterns
• 🎨 UI/UX improvements
• 🐛 Bug fixes and stability
• 📖 Better documentation
• 💡 New features npm run compile

### Run Extension

Press **F5** in VS Code to launch Extension Development Host

### Run Tests

```👨‍💻 Author

**NextGenCode** - Full Stack Developer & Security Enthusiast

- 🌐 Website: [nextgencode.dev](https://nextgencode.dev)
- 🐙 GitHub: [@Mattzey](https://github.com/Mattzey)
- 💼 LinkedIn: [Matteo NextGenCode](https://www.linkedin.com/in/matteo-nextgencode-a64532395)

### Specializing In:
- 🔒 **Cybersecurity** - Secure code analysis and penetration testing
- ⛓️ **Blockchain** - Smart contracts and Web3 development
- 🤖 **AI/ML** - Machine learning and automation
- 🌐 **Full Stack** - React, Node.js, Python, TypeScript

- [NextGenCoin (NGC)](https://www.nextgencode.dev) - Revolutionary cryptocurrency
- [ChainSec Auditing](https://www.nextgencode.dev) - Smart contract audits
- [More projects](https://www.nextgencode.dev#projects)

---

<div align="center">

**Made with 💜 by NextGenCode**

`<nextgencode />`

</div>