GuardScan

100% Kostenlos und Open Source • Datenschutzorientierte Sicherheitsscans und KI Code Review CLI

• ✅ Unbegrenzte statische Analyse – 9 Sicherheitsscanner + Code-Qualitätstools
• ✅ KI-gestützte Code-Review – Bringen Sie Ihren eigenen API-Key mit (OpenAI, Claude, Gemini, Ollama)
• ✅ Funktioniert vollständig offline – Keine Internetverbindung für statische Analyse erforderlich
• ✅ Datenschutz first – Lädt niemals Ihren Quellcode hoch
• ✅ Keine Nutzungsbeschränkungen – Scannen Sie unbegrenzt LOC, unbegrenzte Repositories

🚀 Schnellstart

🐳 Docker / Alpine Linux

Für Docker-Umgebungen, insbesondere Alpine Linux:

Dokumentation:

• 📖 Umfassender Docker-Leitfaden – Vollständige Anleitung für Linux, macOS und Windows
• 🐧 Docker & Alpine Kurzreferenz – Alpine-Linux-spezifische Kurzreferenz

📋 Kernfunktionen

🔒 Sicherheits-Scanning (KOSTENLOS, offline)

GuardScan enthält umfassende Sicherheitsscanner:

1. Secrets Detection – Findet hartcodierte API-Keys, Passwörter, Tokens (20+ Muster)
2. Dependency Vulnerabilities – Scannt npm, pip, Maven, Cargo-Abhängigkeiten
3. OWASP Top 10 – SQL-Injection, XSS, unsichere Konfigurationen, CSRF, XXE
4. Docker Security – Dockerfile- und Container-Scanning
5. Infrastructure as Code – Terraform-, CloudFormation-, Kubernetes-Sicherheit
6. API Security – REST- und GraphQL-Endpunkt-Analyse

📊 Code-Qualität & Analyse (KOSTENLOS, offline)

7. Code Metrics – Zyklomatische Komplexität, Halstead-Metriken, Wartbarkeitsindex
8. Code Smells – 30+ Anti-Patterns (God Classes, lange Methoden, magische Zahlen)
9. License Compliance – Lizenzprüfung von Abhängigkeiten (MIT, GPL, Apache usw.)
10. Compliance Checks – GDPR-, HIPAA-, PCI-DSS-Compliance-Scanning
11. Linter Integration – ESLint, Pylint, RuboCop usw.
12. LOC Counter – Sprachbewusste Zeilenzählung (20+ Sprachen)

🧪 Test & Performance (KOSTENLOS, offline)

13. Test Runner – Ausführen und Analysieren von Jest-, pytest-, JUnit-Tests
14. Mutation Testing – Validierung der Test-Suite-Effektivität (erfordert Stryker – optional)
15. Performance Testing – Lasttests und Benchmarking (erfordert k6 – optional)
16. SBOM Generation – Software-Stückliste (CycloneDX, SPDX)

Hinweis: Performance- und Mutationstests erfordern optionale externe Tools.

🤖 KI-gestützte Funktionen (BYOK – Bring Your Own Key)

9 erweiterte KI-gestützte Funktionen:

1. Code Explainer (guardscan explain) – Komplexen Code verstehen
2. Code Review (guardscan review) – Umfassende KI-Code-Review
3. Commit Generator (guardscan commit) – Commit-Nachrichten generieren
4. Docs Generator (guardscan docs) – Dokumentation automatisch generieren
5. Test Generator (guardscan test-gen) – Unit-Tests generieren
6. Refactoring Suggestions (guardscan refactor) – Code-Qualität verbessern
7. Threat Modeling (guardscan threat-model) – Sicherheitsarchitektur-Analyse
8. Migration Assistant (guardscan migrate) – Framework-/Sprachmigrationen
9. Interactive Chat (guardscan chat) – RAG-gestützte Codebase-Fragen

🌍 Mehrsprachen-Unterstützung

AST-Parser für 7+ Sprachen:

• TypeScript/JavaScript
• Python
• Java
• Go
• Rust
• Ruby
• PHP
• C#

🔌 KI-Anbieter-Integrationen

Konfigurieren Sie jeden gewünschten KI-Anbieter:

• OpenAI (GPT-4, GPT-4 Turbo, GPT-3.5)
• Anthropic Claude (Claude 3 Opus, Sonnet, Haiku)
• Google Gemini (Gemini Pro)
• Ollama (Lokal, datenschutzorientiert – llama2, codellama, mistral)
• LM Studio (Lokale Modelle)
• OpenRouter (Zugriff auf mehrere Modelle)

Sie zahlen den KI-Anbieter direkt – GuardScan verlangt nichts!

🛠️ Befehle

Alle Befehle sind 100% KOSTENLOS ohne Einschränkungen!

Konfigurationsbefehle

Sicherheits- & Analysebefehle

Test- & Qualitätsbefehle

Hinweis: Die Befehle perf und mutation erfordern optionale externe Tools. Siehe Testing Tools Guide für Installations- und Nutzungsdetails.

Hilfsbefehle

KI-gestützte Befehle (BYOK)

🔒 Datenschutzgarantien

Wir nehmen Datenschutz ernst:

❌ Niemals gespeichert oder übertragen

• Ihr Quellcode
• Dateipfade oder Dateinamen
• Codeausschnitte
• API-Keys oder Geheimnisse
• Proprietäre Informationen

✅ Optionale Telemetrie (anonymisiert)

• Befehlsnutzung (z. B. Befehl "security" ausgeführt)
• Ausführungsdauer
• LOC-Anzahl (nur Gesamtzahl)
• Verwendetes KI-Modell (z. B. "gpt-4")

Telemetrie ist:

• Optional (einfach deaktivierbar: guardscan config --telemetry=false)
• Vollständig anonymisiert
• Nur zur Verbesserung von GuardScan
• Wird niemals verkauft oder weitergegeben

🎯 So funktioniert es

Statische Analyse (offline, kein KI)

Führt 9 Sicherheitsscanner lokal aus:

• Scannt Ihre Codebasis
• Generiert einen Markdown-Bericht
• 100% offline – keine Internetverbindung nötig
• 100% kostenlos – keine Einschränkungen

KI-gestützte Überprüfung (Ihr API-Key)

So funktioniert es:

1. GuardScan analysiert Ihren Code lokal
2. Sendet anonymisierten Kontext an Ihren KI-Anbieter (mit Ihrem API-Key)
3. KI liefert Erkenntnisse und Vorschläge
4. Bericht wird lokal gespeichert

Sie zahlen Ihren KI-Anbieter direkt – GuardScan ist kostenlos!

💰 Preise

GuardScan: $0 (100% kostenlos)

Kein Guthabensystem. Keine Abonnements. Keine Bezahlschranken.

KI-Anbieter (falls Sie KI-Funktionen nutzen)

Sie zahlen diese direkt (nicht GuardScan):

• OpenAI GPT-4: ~$0.01–0.03 pro 1.000 Tokens
• Claude Sonnet: ~$0.003 pro 1.000 Tokens
• Gemini Pro: Kostenlose Stufe verfügbar
• Ollama: 100% kostenlos (läuft lokal)

Beispielkosten für 10.000 LOC Codebasis:

• Nur statische Analyse: $0
• Mit OpenAI GPT-4: ~$2–5 (an OpenAI gezahlt)
• Mit Ollama (lokal): $0

🏗️ Architektur

GuardScan folgt einer datenschutzorientierten Client-seitigen Architektur, bei der die gesamte Codeanalyse lokal erfolgt.

Technologie-Stack

CLI (34.213 LOC):

• Sprache: TypeScript 5.3+ (strict mode)
• Runtime: Node.js 18+
• Framework: Commander.js
• Tests: Jest (70%+ Abdeckung)
• Build: TypeScript Compiler (tsc)

Monitoring-Dienst (separates Repository, optional):

• Lebt in ntanwir10/GuardScan-Monitoring
• Plattform: Cloudflare Workers + Supabase PostgreSQL
• Zweck: Anonyme Telemetrie und Fehler-/Nutzungsanalyse
• Die CLI kommuniziert nur per HTTP damit; überschreiben Sie die URL mit GUARDSCAN_API_URL

📦 Installation

Über NPM (empfohlen)

Aus dem Quellcode

🤝 Mitwirken

GuardScan ist Open Source und wir freuen uns über Beiträge!

• Fehler melden: GitHub Issues
• Funktionen anfragen: GitHub Issues
• PRs einreichen: Siehe CONTRIBUTING.md

📚 Dokumentation

• Installationsanleitung
• Konfigurationsanleitung
• Chat-Anleitung
• API-Dokumentation
• Sicherheitsscanner
• Richtlinien zum Mitwirken

❓ FAQ

F: Ist GuardScan wirklich kostenlos? A: Ja! 100% kostenlos, kein Guthabensystem, keine Abonnements, keine Einschränkungen.

F: Muss ich ein Konto erstellen? A: Nein! Einfach npm install -g guardscan und guardscan init ausführen.

F: Brauche ich einen KI-API-Key? A: Nur, wenn Sie KI-gestützte Überprüfungen wünschen. Die statische Analyse (9 Sicherheitsscanner) funktioniert ohne API-Key.

F: Welchen KI-Anbieter soll ich nutzen? A: Ihre Wahl! OpenAI (leistungsstark), Claude (ausgewogen), Gemini (günstig), Ollama (kostenlos, lokal).

F: Lädt GuardScan meinen Code hoch? A: Niemals. GuardScan lädt nur anonymisierte Metadaten für optionale Telemetrie hoch.

F: Kann ich Telemetrie deaktivieren? A: Ja! Führen Sie guardscan config --telemetry=false aus oder setzen Sie telemetryEnabled: false in ~/.guardscan/config.yml.

F: Wie kann ich dieses Projekt unterstützen? A: Star das Repository auf GitHub, trage Code bei, melde Fehler oder sponsore das Projekt!

📝 Lizenz

MIT License – siehe LICENSE

🙏 Danksagungen

GuardScan wird mit diesen großartigen Open-Source-Tools erstellt:

• Commander.js – CLI-Framework
• Chalk – Terminal-Styling
• Axios – HTTP-Client
• Cloudflare Workers – Serverloses Backend
• Supabase – Open-Source-Firebase-Alternative

📞 Support

• Issues: GitHub Issues
• Diskussionen: GitHub Discussions
• E-Mail: [email protected] (demnächst verfügbar)