100% 免费且开源 • 隐私至上的安全扫描与 AI 代码审查 CLI
100% 免费且开源 • 隐私优先的安全扫描与 AI 代码审查 CLI
____ _ _ _ ____ ____ ____ ____ _ _ _ ____ _ ___
/ ___| | | | / \ | _ \| _ \ / ___| / ___| / \ | \ | | / ___| | |_ _|
| | _| | | |/ _ \ | |_) | | | | \___ \| | / _ \ | \| | _____ | | | | | |
| |_| | |_| / ___ \| _ <| |_| | ___) | |___ / ___ \| |\ | |_____| | |___| |___ | |
\____|\___/_/ \_\_| \_\____/ |____/ \____/_/ \_\_| \_| \____|_____|___|
Privacy-First AI Code Review & Security Scanning
GuardScan 是 100% 免费且开源的！没有积分系统，没有付费墙，没有订阅。
# 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：
# 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
文档：
GuardScan 包含全面的安全扫描器：
注意：性能测试和变异测试需要可选的外部工具。
9 项高级 AI 驱动功能：
guardscan explain）- 理解复杂代码guardscan review）- 全面的 AI 代码审查guardscan commit）- 生成提交信息guardscan docs）- 自动生成文档guardscan test-gen）- 生成单元测试guardscan refactor）- 提升代码质量guardscan threat-model）- 安全架构分析guardscan migrate）- 框架/语言迁移guardscan chat）- 基于 RAG 的代码库问答支持 7+ 种语言的 AST 解析器：
配置任意你偏好的 AI 提供商：
你直接向 AI 提供商付费 - GuardScan 不收取任何费用！
所有命令均 100% 免费，没有限制！
| 命令 | 描述 |
|---|---|
guardscan init | 初始化配置，生成 client_id |
guardscan config | 配置 AI 提供商与设置 |
guardscan status | 显示配置和仓库信息 |
| 命令 | 描述 |
|---|---|
guardscan security | 运行全面安全扫描（离线） |
guardscan scan | 快速安全扫描 |
guardscan run | AI 增强的完整代码审查（BYOK） |
| 命令 | 描述 |
|---|---|
guardscan test | 运行测试与代码质量分析 |
guardscan perf | 性能测试与负载测试（需要 k6 - 可选） |
guardscan mutation | 用于测试质量的变异测试（需要 Stryker - 可选） |
注意：perf 和 mutation 命令需要可选的外部工具。有关安装和使用详情，请参阅 测试工具指南。
| 命令 | 描述 |
|---|---|
guardscan sbom | 生成软件物料清单 |
guardscan rules | 基于 YAML 的自定义规则引擎 |
我们非常重视隐私：
遥测数据：
guardscan config --telemetry=false）guardscan security
在本地运行 9 个安全扫描器：
# 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
工作原理：
你直接向 AI 提供商付费 - GuardScan 是免费的！
没有积分系统。没有订阅。没有付费墙。
你直接向他们付费（而非 GuardScan）：
10K 行代码库的示例成本：
GuardScan 采用隐私优先的客户端架构，所有代码分析均在本地完成。
┌─────────────────────────────────────────────────────────────┐
│ 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 │
└──────────────────────────┘ └──────────────────────────┘
CLI（34,213 行代码）：
监控服务（独立仓库，可选）：
GUARDSCAN_API_URL 覆盖该 URLnpm install -g guardscan
# 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
GuardScan 是开源项目，我们欢迎贡献！
问：GuardScan 真的免费吗？ 答：是的！100% 免费，没有积分系统，没有订阅，没有限制。
问：我需要创建账户吗？
答：不需要！只需执行 npm install -g guardscan 并运行 guardscan init。
问：我需要 AI API 密钥吗？ 答：仅当你需要 AI 增强审查时才需要。静态分析（9 个安全扫描器）无需任何 API 密钥即可工作。
问：我应该使用哪个 AI 提供商？ 答：由你选择！OpenAI（功能强大）、Claude（均衡）、Gemini（经济实惠）、Ollama（免费、本地）。
问：GuardScan 会上传我的代码吗？ 答：绝不会。GuardScan 仅上传匿名元数据用于可选遥测。
问：我可以禁用遥测吗？
答：可以！运行 guardscan config --telemetry=false，或在 ~/.guardscan/config.yml 中设置 telemetryEnabled: false。
问：我如何支持这个项目？ 答：在 GitHub 上为仓库加星，贡献代码，报告 Bug，或赞助该项目！
MIT 许可证 - 参见 LICENSE
GuardScan 使用以下出色的开源工具构建：
由开发者用 ❤️ 为开发者打造
guardscan reset | 清除本地缓存与配置 |
| 命令 | 描述 |
|---|
guardscan explain <file> | 解释代码的工作原理 |
guardscan review <file> | 全面的 AI 代码审查 |
guardscan commit | 生成提交信息 |
guardscan docs <file> | 自动生成文档 |
guardscan test-gen <file> | 生成单元测试 |
guardscan refactor <file> | 获取重构建议 |
guardscan threat-model | 安全架构分析 |
guardscan migrate | 框架/语言迁移帮助 |
guardscan chat | 关于代码库的交互式问答（RAG） |