🛡️ GuardScan

100% Gratuito y de Código Abierto • Escaneo de Seguridad Centrado en la Privacidad y CLI de Revisión de Código con IA

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

 Privacy-First AI Code Review & Security Scanning

🎉 Completamente Gratuito - Sin Suscripciones, Sin Límites

GuardScan es 100% gratuito y de código abierto! Sin sistema de créditos, sin muros de pago, sin suscripciones.

Lo Que Obtienes (Todo GRATIS)

• ✅ Análisis estático ilimitado - 9 escáneres de seguridad + herramientas de calidad de código
• ✅ Revisión de código mejorada con IA - Trae tu propia clave API (OpenAI, Claude, Gemini, Ollama)
• ✅ Funciona completamente sin conexión - No se requiere internet para el análisis estático
• ✅ Prioridad a la privacidad - Nunca sube tu código fuente
• ✅ Sin límites de uso - Escanea líneas de código ilimitadas, repositorios ilimitados

🚀 Inicio Rápido

# 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

Para entornos Docker, especialmente 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

Documentación:

• 📖 Guía Completa de Docker - Guía completa para Linux, macOS y Windows
• 🐧 Referencia Rápida de Docker y Alpine - Referencia rápida específica para Alpine Linux

📋 Características Principales

🔒 Escaneo de Seguridad (GRATIS, Sin Conexión)

GuardScan incluye escáneres de seguridad integrales:

1. Detección de Secretos - Encuentra claves API, contraseñas, tokens hardcodeados (20+ patrones)
2. Vulnerabilidades de Dependencias - Escanea dependencias npm, pip, Maven, Cargo
3. OWASP Top 10 - Inyección SQL, XSS, configuraciones inseguras, CSRF, XXE
4. Seguridad Docker - Escaneo de Dockerfile y contenedores
5. Infraestructura como Código - Seguridad en Terraform, CloudFormation, Kubernetes
6. Seguridad API - Análisis de endpoints REST y GraphQL

📊 Calidad y Análisis de Código (GRATIS, Sin Conexión)

7. Métricas de Código - Complejidad ciclomática, métricas de Halstead, índice de mantenibilidad
8. Code Smells - 30+ anti-patrones (clases dios, métodos largos, números mágicos)
9. Cumplimiento de Licencias - Verifica licencias de dependencias (MIT, GPL, Apache, etc.)
10. Verificaciones de Cumplimiento - Escaneo de cumplimiento GDPR, HIPAA, PCI-DSS
11. Integración de Linters - ESLint, Pylint, RuboCop, etc.
12. Contador de Líneas - Conteo de líneas consciente del lenguaje (20+ idiomas)

🧪 Pruebas y Rendimiento (GRATIS, Sin Conexión)

13. Ejecutor de Pruebas - Ejecuta y analiza pruebas Jest, pytest, JUnit
14. Pruebas de Mutación - Valida la efectividad del conjunto de pruebas (requiere Stryker - opcional)
15. Pruebas de Rendimiento - Pruebas de carga y benchmarking (requiere k6 - opcional)
16. Generación de SBOM - Lista de materiales de software (CycloneDX, SPDX)

Nota: Las pruebas de rendimiento y mutación requieren herramientas externas opcionales.

🤖 Funciones Mejoradas con IA (BYOK - Trae Tu Propia Clave)

9 Funciones Avanzadas Impulsadas por IA:

1. Explicador de Código (guardscan explain) - Comprende código complejo
2. Revisión de Código (guardscan review) - Revisión integral de código con IA
3. Generador de Commits (guardscan commit) - Genera mensajes de commit
4. Generador de Documentación (guardscan docs) - Genera documentación automáticamente
5. Generador de Pruebas (guardscan test-gen) - Genera pruebas unitarias
6. Sugerencias de Refactorización (guardscan refactor) - Mejora la calidad del código
7. Modelado de Amenazas (guardscan threat-model) - Análisis de arquitectura de seguridad
8. Asistente de Migración (guardscan migrate) - Migraciones de framework/lenguaje
9. Chat Interactivo (guardscan chat) - Preguntas y respuestas sobre el código base con RAG

🌍 Soporte Multi-Idioma

Analizadores AST para 7+ Idiomas:

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

🔌 Integraciones de Proveedores de IA

Configura cualquier proveedor de IA que prefieras:

• OpenAI (GPT-4, GPT-4 Turbo, GPT-3.5)
• Anthropic Claude (Claude 3 Opus, Sonnet, Haiku)
• Google Gemini (Gemini Pro)
• Ollama (Local, centrado en privacidad - llama2, codellama, mistral)
• LM Studio (Modelos locales)
• OpenRouter (Acceso a múltiples modelos)

Tú pagas al proveedor de IA directamente - ¡GuardScan no cobra nada!

🛠️ Comandos

¡Todos los comandos son 100% GRATUITOS sin límites!

Comandos de Configuración

Comandos de Seguridad y Análisis

Comandos de Pruebas y Calidad

Nota: Los comandos perf y mutation requieren herramientas externas opcionales. Consulta la Guía de Herramientas de Pruebas para detalles de instalación y uso.

Comandos de Utilidad

Comandos Impulsados por IA (BYOK)

🔒 Garantías de Privacidad

Tomamos la privacidad en serio:

❌ Nunca Almacenado ni Transmitido

• Tu código fuente
• Rutas de archivo o nombres de archivo
• Fragmentos de código
• Claves API o secretos
• Información propietaria

✅ Telemetría Opcional (Anonimizada)

• Uso de comandos (ej., se ejecutó el comando "security")
• Duración de la ejecución
• Conteo de LOC (solo número agregado)
• Modelo de IA utilizado (ej., "gpt-4")

La telemetría es:

• Opcional (fácilmente deshabilitable: guardscan config --telemetry=false)
• Completamente anonimizada
• Solo se usa para mejorar GuardScan
• Nunca se vende ni comparte

🎯 Cómo Funciona

Análisis Estático (Sin Conexión, Sin IA)

guardscan security

Ejecuta 9 escáneres de seguridad localmente:

• Escanea tu base de código
• Genera un informe en markdown
• 100% sin conexión - no se necesita internet
• 100% gratuito - sin límites

Revisión Mejorada con IA (Tu Clave 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

Cómo funciona:

1. GuardScan analiza tu código localmente
2. Envía contexto anonimizado a tu proveedor de IA (usando tu clave API)
3. La IA proporciona información y sugerencias
4. Informe guardado localmente

Tú pagas a tu proveedor de IA directamente - ¡GuardScan es gratuito!

💰 Precios

GuardScan: $0 (100% Gratuito)

Sin sistema de créditos. Sin suscripciones. Sin muros de pago.

Proveedores de IA (Si Usas Funciones de IA)

Tú les pagas directamente (no a GuardScan):

• OpenAI GPT-4: ~$0.01-0.03 por cada 1K tokens
• Claude Sonnet: ~$0.003 por cada 1K tokens
• Gemini Pro: Nivel gratuito disponible
• Ollama: 100% gratuito (se ejecuta localmente)

Costos de ejemplo para una base de código de 10K LOC:

• Solo análisis estático: $0
• Con OpenAI GPT-4: ~$2-5 (pagado a OpenAI)
• Con Ollama (local): $0

🏗️ Arquitectura

GuardScan sigue una arquitectura centrada en la privacidad y del lado del cliente donde todo el análisis de código ocurre localmente.

┌─────────────────────────────────────────────────────────────┐
│                    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  │
└──────────────────────────┘  └──────────────────────────┘

Pila Tecnológica

CLI (34,213 LOC):

• Lenguaje: TypeScript 5.3+ (modo estricto)
• Runtime: Node.js 18+
• Framework: Commander.js
• Pruebas: Jest (cobertura del 70%+)
• Compilación: TypeScript Compiler (tsc)

Servicio de monitoreo (repositorio separado, opcional):

• Vive en ntanwir10/GuardScan-Monitoring
• Plataforma: Cloudflare Workers + Supabase PostgreSQL
• Propósito: Telemetría anónima y análisis de errores/uso
• El CLI se comunica con él solo a través de HTTP; sobrescribe la URL con GUARDSCAN_API_URL

📦 Instalación

Via NPM (Recomendado)

npm install -g guardscan

Desde el Código Fuente

# 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

🤝 Contribuciones

GuardScan es código abierto y ¡damos la bienvenida a las contribuciones!

• Reportar errores: GitHub Issues
• Solicitar funciones: GitHub Issues
• Enviar PRs: Consulta CONTRIBUTING.md

📚 Documentación

• Guía de Instalación
• Guía de Configuración
• Guía de Chat
• Documentación de API
• Escáneres de Seguridad
• Guías de Contribución

❓ FAQ

P: ¿GuardScan es realmente gratuito? R: ¡Sí! 100% gratuito, sin sistema de créditos, sin suscripciones, sin límites.

P: ¿Necesito crear una cuenta? R: ¡No! Solo npm install -g guardscan y ejecuta guardscan init.

P: ¿Necesito una clave API de IA? R: Solo si deseas la revisión mejorada con IA. El análisis estático (9 escáneres de seguridad) funciona sin ninguna clave API.

P: ¿Qué proveedor de IA debo usar? R: ¡Tú decides! OpenAI (potente), Claude (equilibrado), Gemini (asequible), Ollama (gratuito, local).

P: ¿GuardScan sube mi código? R: Nunca. GuardScan solo sube metadatos anonimizados para telemetría opcional.

P: ¿Puedo deshabilitar la telemetría? R: ¡Sí! Ejecuta guardscan config --telemetry=false o establece telemetryEnabled: false en ~/.guardscan/config.yml.

P: ¿Cómo puedo apoyar este proyecto? R: ¡Dale estrella al repositorio en GitHub, contribuye código, reporta errores o patrocina el proyecto!

📝 Licencia

Licencia MIT - consulta LICENSE

🙏 Agradecimientos

GuardScan está construido con estas increíbles herramientas de código abierto:

• Commander.js - Framework de CLI
• Chalk - Estilizado de terminal
• Axios - Cliente HTTP
• Cloudflare Workers - Backend serverless
• Supabase - Alternativa de código abierto a Firebase

📞 Soporte

• Problemas: GitHub Issues
• Discusiones: GitHub Discussions
• Correo electrónico: [email protected] (próximamente)