🛡️ GuardScan

100% Gratuito e de Código Aberto • CLI de Verificação de Segurança com Prioridade na Privacidade e Revisão de Código com IA

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

 Privacy-First AI Code Review & Security Scanning

---

🎉 Completamente Gratuito - Sem Assinaturas, Sem Limites

O GuardScan é 100% gratuito e de código aberto! Sem sistema de créditos, sem paywalls, sem assinaturas.

O Que Você Recebe (Tudo GRÁTIS)

• ✅ 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 - Escaneie LOC 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 do Docker - Guia completo para Linux, macOS e Windows
• 🐧 Referência Rápida do Docker e Alpine - Referência rápida específica para Alpine Linux

---

📋 Funcionalidades Principais

🔒 Verificação de Segurança (GRATUITA, Offline)

O GuardScan inclui verificadores de segurança abrangentes:

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

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

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

🧪 Testes e Desempenho (GRATUITOS, Offline)

13. Executor de Testes - Execute e analise testes Jest, pytest e JUnit
14. Teste de Mutação - Valide a eficácia da suíte de testes (requer Stryker - opcional)
15. Testes de Desempenho - Testes de carga e benchmarking (requer k6 - opcional)
16. Geração de SBOM - Software Bill of Materials (CycloneDX, SPDX)

Nota: Os testes de desempenho e de 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ódigos complexos
2. Revisão de Código (guardscan review) - Revisão de código abrangente com IA
3. Gerador de Commits (guardscan commit) - Gere mensagens de commit
4. Gerador de Documentação (guardscan docs) - Gere documentação 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 que preferir:

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

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

---

🛠️ Comandos

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

Comandos de Configuração

Comando	Descrição
guardscan init	Inicializa a configuração, gera o client_id
guardscan config	Configura o provedor de IA e as definições
guardscan status	Exibe a configuração e informações do repositório
guardscan reset	Limpa o cache local e a configuração

Comandos de Segurança e Análise

Comando	Descrição
guardscan security	Executa uma verificação de segurança abrangente (offline)
guardscan scan	Verificação de segurança rápida
guardscan run	Revisão completa de código aprimorada por IA (BYOK)

Comandos de Testes e Qualidade

Comando	Descrição
guardscan test	Executa testes e análise de qualidade de código
guardscan perf	Testes de desempenho e testes de carga (requer k6 - opcional)
guardscan mutation	Testes de mutação para qualidade de testes (requer Stryker - opcional)

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

Comandos Utilitários

Comando	Descrição
guardscan sbom	Gera Software Bill of Materials
guardscan rules	Motor de regras personalizado baseado em YAML

Comandos com IA (BYOK)