🛡️ GuardScan

100 % gratuit et open source • CLI d'analyse de sécurité et de revue de code IA respectueuse de la vie privée

  ____ _   _   _    ____  ____    ____   ____    _    _   _            ____ _     ___ 
 / ___| | | | / \  |  _ \|  _ \  / ___| / ___|  / \  | \ | |          / ___| |   |_ _|
| |  _| | | |/ _ \ | |_) | | | | \___ \| |     / _ \ |  \| |  _____  | |   | |    | |
| |_| | |_| / ___ \|  _ <| |_| |  ___) | |___ / ___ \| |\  | |_____| | |___| |___ | | 
 \____|\___/_/   \_\_| \_\____/  |____/ \____/_/   \_\_| \_|          \____|_____|___|

 Privacy-First AI Code Review & Security Scanning

🎉 Entièrement gratuit - Sans abonnement, sans limites

GuardScan est 100 % gratuit et open source ! Pas de système de crédits, pas de paywall, pas d'abonnements.

Ce que vous obtenez (tout est GRATUIT)

• ✅ Analyse statique illimitée - 9 scanners de sécurité + outils de qualité de code
• ✅ Revue de code assistée par IA - Apportez votre propre clé API (OpenAI, Claude, Gemini, Ollama)
• ✅ Fonctionne entièrement hors ligne - Aucune connexion Internet requise pour l'analyse statique
• ✅ Confidentialité avant tout - Ne téléverse jamais votre code source
• ✅ Aucune limite d'utilisation - Analysez un nombre illimité de lignes de code et de dépôts

🚀 Démarrage rapide

# Install globally via npm
npm install -g guardscan

# Initialize GuardScan
guardscan init

# Run comprehensive security scan (100% FREE, offline)
guardscan security

# Configure AI provider for enhanced review (optional, BYOK)
guardscan config

# Run AI-enhanced code review
guardscan run

# Check status
guardscan status

🐳 Docker / Alpine Linux

Pour les environnements Docker, en particulier Alpine Linux :

# Install dependencies first
apk add --no-cache python3 make g++ pkgconfig cairo-dev pango-dev \
  libjpeg-turbo-dev giflib-dev pixman-dev freetype-dev build-base git

# Install GuardScan
npm install -g guardscan

# Set home directory (important for Docker)
export GUARDSCAN_HOME=/app/.guardscan

# Initialize
guardscan init

Documentation :

• 📖 Guide Docker complet - Guide complet pour Linux, macOS et Windows
• 🐧 Référence rapide Docker et Alpine - Référence rapide spécifique à Alpine Linux

📋 Fonctionnalités principales

🔒 Analyse de sécurité (GRATUITE, hors ligne)

GuardScan inclut des scanners de sécurité complets :

1. Détection de secrets - Trouve les clés API codées en dur, les mots de passe, les jetons (20+ modèles)
2. Vulnérabilités des dépendances - Analyse les dépendances npm, pip, Maven, Cargo
3. OWASP Top 10 - Injection SQL, XSS, configurations non sécurisées, CSRF, XXE
4. Sécurité Docker - Analyse des Dockerfiles et des conteneurs
5. Infrastructure en tant que code - Sécurité de Terraform, CloudFormation, Kubernetes
6. Sécurité des API - Analyse des points de terminaison REST et GraphQL

📊 Qualité et analyse du code (GRATUIT, hors ligne)

7. Métriques de code - Complexité cyclomatique, métriques de Halstead, indice de maintenabilité
8. Odeurs de code - 30+ anti-modèles (classes god, méthodes longues, nombres magiques)
9. Conformité des licences - Vérifie les licences des dépendances (MIT, GPL, Apache, etc.)
10. Vérifications de conformité - Analyse de conformité GDPR, HIPAA, PCI-DSS
11. Intégration de linters - ESLint, Pylint, RuboCop, etc.
12. Compteur de lignes de code - Comptage de lignes adapté au langage (20+ langages)

🧪 Tests et performances (GRATUIT, hors ligne)

13. Exécuteur de tests - Exécute et analyse les tests Jest, pytest, JUnit
14. Tests de mutation - Valide l'efficacité de la suite de tests (nécessite Stryker - optionnel)
15. Tests de performance - Tests de charge et benchmarking (nécessite k6 - optionnel)
16. Génération de SBOM - Software Bill of Materials (CycloneDX, SPDX)

Remarque : Les tests de performance et de mutation nécessitent des outils externes optionnels.

🤖 Fonctionnalités assistées par IA (BYOK - Apportez votre propre clé)

9 fonctionnalités avancées propulsées par l'IA :

1. Explication de code (guardscan explain) - Comprendre un code complexe
2. Revue de code (guardscan review) - Revue de code IA complète
3. Générateur de commits (guardscan commit) - Génère des messages de commit
4. Générateur de documentation (guardscan docs) - Génère automatiquement la documentation
5. Générateur de tests (guardscan test-gen) - Génère des tests unitaires
6. Suggestions de refactoring (guardscan refactor) - Améliore la qualité du code
7. Modélisation des menaces (guardscan threat-model) - Analyse de l'architecture de sécurité
8. Assistant de migration (guardscan migrate) - Migrations de framework/langage
9. Chat interactif (guardscan chat) - Questions-réponses sur la base de code propulsées par RAG

🌍 Prise en charge multi-langages

Analyseurs AST pour 7+ langages :

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

🔌 Intégrations de fournisseurs d'IA

Configurez le fournisseur d'IA de votre choix :

• OpenAI (GPT-4, GPT-4 Turbo, GPT-3.5)
• Anthropic Claude (Claude 3 Opus, Sonnet, Haiku)
• Google Gemini (Gemini Pro)
• Ollama (local, axé confidentialité - llama2, codellama, mistral)
• LM Studio (modèles locaux)
• OpenRouter (accès à plusieurs modèles)

Vous payez le fournisseur d'IA directement - GuardScan ne facture rien !

🛠️ Commandes

Toutes les commandes sont 100 % GRATUITES, sans aucune limite !

Commandes de configuration

Commandes de sécurité et d'analyse

Commandes de test et de qualité

Remarque : les commandes perf et mutation nécessitent des outils externes optionnels. Consultez le Guide des outils de test pour les détails d'installation et d'utilisation.

Commandes utilitaires

Commandes propulsées par l'IA (BYOK)

🔒 Garanties de confidentialité

Nous prenons la confidentialité au sérieux :

❌ Jamais stocké ni transmis

• Votre code source
• Les chemins ou noms de fichiers
• Les extraits de code
• Les clés API ou secrets
• Les informations propriétaires

✅ Télémétrie optionnelle (anonymisée)

• Utilisation des commandes (par ex., exécution de la commande « security »)
• Durée d'exécution
• Nombre de lignes de code (nombre agrégé uniquement)
• Modèle d'IA utilisé (par ex., « gpt-4 »)

La télémétrie est :

• Optionnelle (facilement désactivable : guardscan config --telemetry=false)
• Entièrement anonymisée
• Uniquement utilisée pour améliorer GuardScan
• Jamais vendue ni partagée

🎯 Comment ça fonctionne

Analyse statique (hors ligne, sans IA)

guardscan security

Exécute 9 scanners de sécurité localement :

• Analyse votre base de code
• Génère un rapport Markdown
• 100 % hors ligne - aucune connexion Internet requise
• 100 % gratuit - sans aucune limite

Revue assistée par IA (votre clé API)

# Step 1: Configure your AI provider (one-time)
guardscan config
# Choose provider: OpenAI, Claude, Gemini, Ollama
# Enter your API key

# Step 2: Run AI review
guardscan run

Comment ça fonctionne :

1. GuardScan analyse votre code localement
2. Envoie un contexte anonymisé à votre fournisseur d'IA (en utilisant votre clé API)
3. L'IA fournit des informations et des suggestions
4. Le rapport est enregistré localement

Vous payez votre fournisseur d'IA directement - GuardScan est gratuit !

💰 Tarifs

GuardScan : 0 $ (100 % gratuit)

Pas de système de crédits. Pas d'abonnements. Pas de paywall.

Fournisseurs d'IA (si vous utilisez les fonctionnalités d'IA)

Vous les payez directement (pas GuardScan) :

• OpenAI GPT-4 : ~0,01-0,03 $ pour 1 000 jetons
• Claude Sonnet : ~0,003 $ pour 1 000 jetons
• Gemini Pro : offre gratuite disponible
• Ollama : 100 % gratuit (fonctionne localement)

Exemples de coûts pour une base de code de 10 000 lignes :

• Analyse statique uniquement : 0 $
• Avec OpenAI GPT-4 : ~2-5 $ (payé à OpenAI)
• Avec Ollama (local) : 0 $

🏗️ Architecture

GuardScan suit une architecture côté client respectueuse de la confidentialité où toute l'analyse du code s'effectue localement.

┌─────────────────────────────────────────────────────────────┐
│                    USER'S MACHINE                            │
│                                                              │
│  ┌─────────────────────────────────────────────────────┐   │
│  │         GuardScan CLI (Node.js/TypeScript)          │   │
│  │                                                      │   │
│  │  • 21 Commands (security, run, test, explain...)    │   │
│  │  • 30 Core Modules (scanners, parsers, metrics)     │   │
│  │  • 9 AI Features (explain, review, test-gen, etc.)  │   │
│  │  • 7 Language Parsers (Python, Java, Go, Rust...)   │   │
│  │  • 6 AI Provider Integrations                       │   │
│  │                                                      │   │
│  │  Config: ~/.guardscan/config.yml                   │   │
│  │  Cache: ~/.guardscan/cache/                        │   │
│  └─────────────────────────────────────────────────────┘   │
│                           │                                  │
│                           │ Optional telemetry only          │
│                           ▼                                  │
└───────────────────────────────────────────────────────────────┘
                            │
                ┌───────────┴──────────┐
                │                      │
                ▼                      ▼
┌──────────────────────────┐  ┌──────────────────────────┐
│  User's AI Provider      │  │  GuardScan Backend       │
│  (User pays directly)    │  │  (Optional telemetry)    │
│                          │  │                          │
│  • OpenAI (GPT-4)        │  │  Cloudflare Workers      │
│  • Anthropic (Claude)    │  │  + Supabase              │
│  • Google (Gemini)       │  │                          │
│  • Ollama (Local)        │  │  • Health checks         │
│                          │  │  • Anonymous telemetry   │
│  User's API Key →        │  │  • NO source code        │
│  User's billing →        │  │  • NO credit validation  │
└──────────────────────────┘  └──────────────────────────┘

Pile technologique

CLI (34 213 lignes de code) :

• Langage : TypeScript 5.3+ (mode strict)
• Runtime : Node.js 18+
• Framework : Commander.js
• Tests : Jest (couverture de 70 %+)
• Build : compilateur TypeScript (tsc)

Service de surveillance (dépôt séparé, optionnel) :

• Vit dans ntanwir10/GuardScan-Monitoring
• Plateforme : Cloudflare Workers + Supabase PostgreSQL
• Objectif : télémétrie anonyme et analyses des erreurs et de l'utilisation
• La CLI communique avec lui uniquement via HTTP ; remplacez l'URL avec GUARDSCAN_API_URL

📦 Installation

Via NPM (recommandé)

npm install -g guardscan

Via la source

# Clone repository
git clone https://github.com/ntanwir10/GuardScan.git
cd GuardScan/cli

# Install dependencies
npm install

# Build
npm run build

# Link globally
npm link

# Verify
guardscan --help

🤝 Contribution

GuardScan est open source et nous accueillons vos contributions !

• Signaler des bugs : GitHub Issues
• Demander des fonctionnalités : GitHub Issues
• Soumettre des PR : voir CONTRIBUTING.md

📚 Documentation

• Guide d'installation
• Guide de configuration
• Guide du chat
• Documentation de l'API
• Scanners de sécurité
• Directives de contribution

❓ FAQ

Q : GuardScan est-il vraiment gratuit ? R : Oui ! 100 % gratuit, pas de système de crédits, pas d'abonnements, pas de limites.

Q : Dois-je créer un compte ? R : Non ! Il suffit d'exécuter npm install -g guardscan puis guardscan init.

Q : Ai-je besoin d'une clé API d'IA ? R : Uniquement si vous souhaitez la revue assistée par IA. L'analyse statique (9 scanners de sécurité) fonctionne sans aucune clé API.

Q : Quel fournisseur d'IA devrais-je utiliser ? R : À vous de choisir ! OpenAI (puissant), Claude (équilibré), Gemini (abordable), Ollama (gratuit, local).

Q : GuardScan téléverse-t-il mon code ? R : Jamais. GuardScan ne téléverse que des métadonnées anonymisées pour la télémétrie optionnelle.

Q : Puis-je désactiver la télémétrie ? R : Oui ! Exécutez guardscan config --telemetry=false ou définissez telemetryEnabled: false dans ~/.guardscan/config.yml.

Q : Comment puis-je soutenir ce projet ? R : Mettez une étoile au dépôt sur GitHub, contribuez au code, signalez des bugs ou parrainez le projet !

📝 Licence

Licence MIT - voir LICENSE

🙏 Remerciements

GuardScan est construit avec ces formidables outils open source :

• Commander.js - Framework CLI
• Chalk - Style de terminal
• Axios - Client HTTP
• Cloudflare Workers - Backend serverless
• Supabase - Alternative open source à Firebase

📞 Support

• Problèmes : GitHub Issues
• Discussions : GitHub Discussions
• E-mail : [email protected] (bientôt disponible)