🛡️ GuardScan

100% Gratuito e Open Source • CLI de Revisão de Código com IA e Varredura de Segurança com Privacidade em Primeiro Lugar

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

 Revisão de Código com IA e Varredura de Segurança com Privacidade em Primeiro Lugar

🎉 Completamente Gratuito - Sem Assinaturas, Sem Limites

O GuardScan é 100% gratuito e open source! Sem sistema de créditos, sem paywalls, sem assinaturas.

O Que Você Obtém (Tudo GRATUITO)

• ✅ Análise estática ilimitada - 9 scanners de segurança + ferramentas de qualidade de código
• ✅ Revisão de código aprimorada por IA - Traga sua própria chave de API (OpenAI, Claude, Gemini, Ollama)
• ✅ Funciona totalmente offline - Sem necessidade de internet para análise estática
• ✅ Privacidade em primeiro lugar - Nunca envia seu código-fonte
• ✅ Sem limites de uso - Analise linhas de código ilimitadas, repositórios ilimitados

🚀 Início 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 ambientes 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

Documentação:

• 📖 Guia Completo para Docker - Guia completo para Linux, macOS e Windows
• 🐧 Referência Rápida para Docker e Alpine - Referência rápida específica para Alpine Linux

📋 Funcionalidades Principais

🔒 Varredura de Segurança (GRATUITO, Offline)

O GuardScan inclui scanners de segurança abrangentes:

1. Detecção de Segredos - Encontre chaves de API, senhas e tokens codificados (20+ padrões)
2. Vulnerabilidades em Dependências - Analise dependências npm, pip, Maven, Cargo
3. OWASP Top 10 - Injeção SQL, XSS, configurações inseguras, CSRF, XXE
4. Segurança Docker - Varredura de Dockerfiles e contêineres
5. Infraestrutura como Código - Segurança em Terraform, CloudFormation, Kubernetes
6. Segurança de API - Análise de endpoints REST e GraphQL

📊 Qualidade e Análise de Código (GRATUITO, Offline)

7. Métricas de Código - Complexidade ciclomática, métricas de Halstead, índice de manutenibilidade
8. Code Smells - 30+ antipadrões (classes Deus, métodos longos, números mágicos)
9. Conformidade de Licenças - Verifique licenças de dependências (MIT, GPL, Apache, etc.)
10. Verificações de Conformidade - Varredura de conformidade com GDPR, HIPAA, PCI-DSS
11. Integração com Linters - ESLint, Pylint, RuboCop, etc.
12. Contador de LOC - Contagem de linhas com reconhecimento de linguagem (20+ idiomas)

🧪 Testes e Performance (GRATUITO, Offline)

13. Executor de Testes - Execute e analise testes Jest, pytest, JUnit
14. Testes de Mutação - Valide a eficácia do conjunto de testes (requer Stryker - opcional)
15. Testes de Performance - Testes de carga e benchmarking (requer k6 - opcional)
16. Geração de SBOM - Lista de Materiais de Software (CycloneDX, SPDX)

Nota: Testes de performance e mutação requerem ferramentas externas opcionais.

🤖 Funcionalidades Aprimoradas por IA (BYOK - Traga Sua Própria Chave)

9 Funcionalidades Avançadas com IA:

1. Explicador de Código (guardscan explain) - Entenda código complexo
2. Revisão de Código (guardscan review) - Revisão abrangente de código com IA
3. Gerador de Commits (guardscan commit) - Gere mensagens de commit
4. Gerador de Documentação (guardscan docs) - Documentação gerada automaticamente
5. Gerador de Testes (guardscan test-gen) - Gere testes unitários
6. Sugestões de Refatoração (guardscan refactor) - Melhore a qualidade do código
7. Modelagem de Ameaças (guardscan threat-model) - Análise de arquitetura de segurança
8. Assistente de Migração (guardscan migrate) - Migrações de framework/linguagem
9. Chat Interativo (guardscan chat) - Perguntas e respostas sobre a base de código com RAG

🌍 Suporte a Múltiplas Linguagens

Parsers AST para 7+ Linguagens:

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

🔌 Integrações com Provedores de IA

Configure qualquer provedor de IA de sua preferência:

• OpenAI (GPT-4, GPT-4 Turbo, GPT-3.5)
• Anthropic Claude (Claude 3 Opus, Sonnet, Haiku)
• Google Gemini (Gemini Pro)
• Ollama (Local, focado em privacidade - llama2, codellama, mistral)
• LM Studio (Modelos locais)
• OpenRouter (Acesso a múltiplos modelos)

Você paga o provedor de IA diretamente - O GuardScan não cobra nada!

🛠️ Comandos

Todos os comandos são 100% GRATUITOS e sem limites!

Comandos de Configuração

Comandos de Segurança e Análise

Comandos de Testes e Qualidade

Nota: Os comandos perf e mutation requerem ferramentas externas opcionais. Consulte o Guia de Ferramentas de Teste para instalação e uso.

Comandos Utilitários

Comandos com IA (BYOK)

🔒 Garantias de Privacidade

Levamos a privacidade a sério:

❌ Nunca Armazenados ou Transmitidos

• Seu código-fonte
• Caminhos ou nomes de arquivos
• Trechos de código
• Chaves de API ou segredos
• Informações proprietárias

✅ Telemetria Opcional (Anonimizada)

• Uso de comandos (ex.: comando "security" executado)
• Duração da execução
• Contagem de LOC (apenas número agregado)
• Modelo de IA utilizado (ex.: "gpt-4")

A telemetria é:

• Opcional (facilmente desativada: guardscan config --telemetry=false)
• Completamente anonimizada
• Usada apenas para melhorar o GuardScan
• Nunca vendida ou compartilhada

🎯 Como Funciona

Análise Estática (Offline, Sem IA)

guardscan security

Executa 9 scanners de segurança localmente:

• Analisa sua base de código
• Gera relatório em markdown
• 100% offline - sem necessidade de internet
• 100% gratuito - sem limites

Revisão Aprimorada por IA (Sua Chave de API)

# Passo 1: Configurar seu provedor de IA (uma vez)
guardscan config
# Escolha o provedor: OpenAI, Claude, Gemini, Ollama
# Insira sua chave de API

# Passo 2: Executar revisão com IA
guardscan run

Como funciona:

1. O GuardScan analisa seu código localmente
2. Envia contexto anonimizado para seu provedor de IA (usando sua chave de API)
3. A IA fornece insights e sugestões
4. Relatório salvo localmente

Você paga seu provedor de IA diretamente - O GuardScan é gratuito!

💰 Preços

GuardScan: $0 (100% Gratuito)

Sem sistema de créditos. Sem assinaturas. Sem paywalls.

Provedores de IA (Se Você Usar Funcionalidades de IA)

Você paga eles diretamente (não o GuardScan):

• OpenAI GPT-4: ~$0,01-0,03 por 1K tokens
• Claude Sonnet: ~$0,003 por 1K tokens
• Gemini Pro: Camada gratuita disponível
• Ollama: 100% gratuito (roda localmente)

Exemplo de custos para base de 10K LOC:

• Apenas análise estática: $0
• Com OpenAI GPT-4: ~$2-5 (pago à OpenAI)
• Com Ollama (local): $0

🏗️ Arquitetura

O GuardScan segue uma arquitetura cliente-side com privacidade em primeiro lugar, onde toda a análise de código ocorre 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  │
└──────────────────────────┘  └──────────────────────────┘

Pilha de Tecnologia

CLI (34.213 LOC):

• Linguagem: TypeScript 5.3+ (modo estrito)
• Runtime: Node.js 18+
• Framework: Commander.js
• Testes: Jest (70%+ de cobertura)
• Build: Compilador TypeScript (tsc)

Serviço de monitoramento (repositório separado, opcional):

• Reside em ntanwir10/GuardScan-Monitoring
• Plataforma: Cloudflare Workers + Supabase PostgreSQL
• Propósito: Telemetria anônima e análises de erro/uso
• O CLI se comunica com ele via HTTP; substitua a URL com GUARDSCAN_API_URL

📦 Instalação

Via NPM (Recomendado)

npm install -g guardscan

Via Código Fonte

# 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

🤝 Contribuindo

O GuardScan é open source e aceitamos contribuições!

• Relatar bugs: GitHub Issues
• Solicitar funcionalidades: GitHub Issues
• Enviar PRs: Veja CONTRIBUTING.md

📚 Documentação

• Guia de Instalação
• Guia de Configuração
• Guia de Chat
• Documentação da API
• Scanners de Segurança
• Diretrizes de Contribuição

❓ Perguntas Frequentes (FAQ)

P: O GuardScan é realmente gratuito? R: Sim! 100% gratuito, sem sistema de créditos, sem assinaturas, sem limites.

P: Preciso criar uma conta? R: Não! Basta npm install -g guardscan e executar guardscan init.

P: Preciso de uma chave de API de IA? R: Apenas se quiser a revisão aprimorada por IA. A análise estática (9 scanners de segurança) funciona sem qualquer chave de API.

P: Qual provedor de IA devo usar? R: Sua escolha! OpenAI (poderoso), Claude (equilibrado), Gemini (acessível), Ollama (gratuito, local).

P: O GuardScan envia meu código? R: Nunca. O GuardScan envia apenas metadados anonimizados para telemetria opcional.

P: Posso desativar a telemetria? R: Sim! Execute guardscan config --telemetry=false ou defina telemetryEnabled: false em ~/.guardscan/config.yml.

P: Como posso apoiar este projeto? R: Dê uma estrela no repositório no GitHub, contribua com código, reporte bugs ou patrocine o projeto!

📝 Licença

Licença MIT - veja LICENSE

🙏 Agradecimentos

O GuardScan é construído com estas incríveis ferramentas open source:

• Commander.js - Framework CLI
• Chalk - Estilização de terminal
• Axios - Cliente HTTP
• Cloudflare Workers - Backend serverless
• Supabase - Alternativa open source ao Firebase

📞 Suporte

• Issues: GitHub Issues
• Discussões: GitHub Discussions
• Email: [email protected] (em breve)