Documentacion de vigil
Bienvenido a la documentacion de vigil, el scanner de seguridad para codigo generado por IA.
Indice
| Documento | Descripcion |
|---|---|
| Inicio rapido | Instalacion, primer scan y conceptos basicos |
| Referencia CLI | Todos los comandos, flags y opciones disponibles |
| Configuracion | Archivo .vigil.yaml, estrategias, overrides y merge de config |
| Reglas | Catalogo completo de las 26 reglas con ejemplos de codigo vulnerable |
| Formatos de salida | Human, JSON, JUnit XML y SARIF 2.1.0 |
| Integracion CI/CD | GitHub Actions, GitLab CI, pre-commit hooks y quality gates |
| Docker | Uso en contenedores, Dockerfile de referencia y buenas practicas |
| Seguridad | Modelo de amenazas, que detecta vigil, alineacion OWASP y limitaciones |
| Arquitectura | Estructura interna, flujo del engine, protocolo de analyzers |
| Buenas practicas | Recomendaciones para equipos que usan agentes de IA para generar codigo |
| Contribuir | Guia para contribuir al proyecto, setup de desarrollo y testing |
Estado del proyecto
vigil esta en desarrollo activo. La version actual (v0.1.0) incluye:
- CLI completa con 5 subcomandos (
scan,deps,tests,init,rules) - Motor de analisis con soporte para multiples analyzers
- 26 reglas definidas en 4 categorias
- 4 formatos de salida (human, JSON, JUnit XML, SARIF 2.1.0)
- Sistema de configuracion con YAML, presets y overrides por CLI
- 125 tests unitarios