🛡️ GuardScan

100%無料＆オープンソース • プライバシー最優先のセキュリティスキャンとAIコードレビューCLI

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

 Privacy-First AI Code Review & Security Scanning

---

🎉 完全無料 - サブスクリプションなし、制限なし

GuardScanは100%無料かつオープンソースです！クレジットシステムもペイウォールもサブスクリプションもありません。

提供されるもの（すべて無料）

• ✅ 無制限の静的解析 - 9つのセキュリティスキャナー＋コード品質ツール
• ✅ AI拡張コードレビュー - お持ちのAPIキーを使用（OpenAI、Claude、Gemini、Ollama）
• ✅ 完全オフライン対応 - 静的解析にインターネットは不要
• ✅ プライバシー最優先 - ソースコードをアップロードすることはありません
• ✅ 利用制限なし - 無制限のLOC、無制限のリポジトリをスキャン

---

🚀 クイックスタート

# 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

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

ドキュメント：

• 📖 総合Dockerガイド - Linux、macOS、Windows向けの完全ガイド
• 🐧 Docker & Alpineクイックリファレンス - Alpine Linux固有のクイックリファレンス

---

📋 コア機能

🔒 セキュリティスキャン（無料、オフライン）

GuardScanには包括的なセキュリティスキャナーが含まれています：

1. シークレット検出 - ハードコードされたAPIキー、パスワード、トークンを検出（20以上のパターン）
2. 依存関係の脆弱性 - npm、pip、Maven、Cargoの依存関係をスキャン
3. OWASP Top 10 - SQLインジェクション、XSS、安全でない設定、CSRF、XXE
4. Dockerセキュリティ - Dockerfileとコンテナのスキャン
5. Infrastructure as Code - Terraform、CloudFormation、Kubernetesのセキュリティ
6. APIセキュリティ - RESTおよびGraphQLエンドポイントの分析

📊 コード品質と分析（無料、オフライン）

7. コードメトリクス - 循環的複雑度、Halsteadメトリクス、保守性指数
8. コードスメル - 30以上のアンチパターン（神クラス、長いメソッド、マジックナンバー）
9. ライセンス準拠 - 依存関係のライセンスを確認（MIT、GPL、Apacheなど）
10. コンプライアンスチェック - GDPR、HIPAA、PCI-DSSのコンプライアンススキャン
11. リンター統合 - ESLint、Pylint、RuboCopなど
12. LOCカウンター - 言語を認識した行数カウント（20以上の言語）

🧪 テストとパフォーマンス（無料、オフライン）

13. テストランナー - Jest、pytest、JUnitテストを実行・分析
14. ミューテーションテスト - テストスイートの有効性を検証（Strykerが必要 - オプション）
15. パフォーマンステスト - 負荷テストとベンチマーク（k6が必要 - オプション）
16. SBOM生成 - ソフトウェア部品表（CycloneDX、SPDX）

注記：パフォーマンステストとミューテーションテストにはオプションの外部ツールが必要です。

🤖 AI拡張機能（BYOK - お持ちのAPIキーを使用）

9つの高度なAI搭載機能:

1. コード説明（guardscan explain）- 複雑なコードを理解
2. コードレビュー（guardscan review）- 包括的なAIコードレビュー
3. コミット生成（guardscan commit）- コミットメッセージを生成
4. ドキュメント生成（guardscan docs）- ドキュメントを自動生成
5. テスト生成（guardscan test-gen）- ユニットテストを生成
6. リファクタリング提案（guardscan refactor）- コード品質を向上
7. 脅威モデリング（guardscan threat-model）- セキュリティアーキテクチャ分析
8. マイグレーションアシスタント（guardscan migrate）- フレームワーク/言語の移行
9. 対話型チャット（guardscan chat）- RAGによるコードベースQ&A

🌍 マルチ言語サポート

7以上の言語向けASTパーサー:

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

🔌 AIプロバイダー連携

お好みのAIプロバイダーを設定できます：

• OpenAI（GPT-4、GPT-4 Turbo、GPT-3.5）
• Anthropic Claude（Claude 3 Opus、Sonnet、Haiku）
• Google Gemini（Gemini Pro）
• Ollama（ローカル、プライバシー重視 - llama2、codellama、mistral）
• LM Studio（ローカルモデル）
• OpenRouter（複数のモデルにアクセス）

AIプロバイダーに直接お支払いいただきます - GuardScanは一切課金しません！

---

🛠️ コマンド

すべてのコマンドは100%無料で制限なし！

設定コマンド

コマンド	説明
guardscan init	設定を初期化し、client_idを生成
guardscan config	AIプロバイダーと設定を構成
guardscan status	設定とリポジトリ情報を表示
guardscan reset	ローカルキャッシュと設定をクリア

セキュリティ＆分析コマンド

コマンド	説明
guardscan security	包括的なセキュリティスキャンを実行（オフライン）
guardscan scan	クイックセキュリティスキャン
guardscan run	AI拡張による完全コードレビュー（BYOK）

テスト＆品質コマンド

コマンド	説明
guardscan test	テストとコード品質分析を実行
guardscan perf	パフォーマンステストと負荷テスト（k6が必要 - オプション）
guardscan mutation	テスト品質のためのミューテーションテスト（Strykerが必要 - オプション）

注記：perf と mutation コマンドにはオプションの外部ツールが必要です。インストールと使用法の詳細はテストツールガイドを参照してください。

ユーティリティコマンド

コマンド	説明
guardscan sbom	ソフトウェア部品表（SBOM）を生成
guardscan rules	カスタムYAMLベースのルールエンジン

AI搭載コマンド（BYOK）

コマンド	説明
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	コードベースに関する対話型Q&A（RAG）

---

🔒 プライバシー保証

私たちはプライバシーを真剣に考えています：

❌ 保存または送信されることはありません

• あなたのソースコード
• ファイルパスまたはファイル名
• コードスニペット
• APIキーまたはシークレット
• 独自情報

✅ オプションのテレメトリー（匿名化）

• コマンドの使用状況（例：「security」コマンドの実行）
• 実行時間
• LOC数（集計数のみ）
• 使用されたAIモデル（例：「gpt-4」）

テレメトリーは：

• オプション（簡単に無効化可能：guardscan config --telemetry=false）
• 完全に匿名化
• GuardScanの改善にのみ使用
• 販売も共有もされません

---

🎯 仕組み

静的解析（オフライン、AIなし）

guardscan security

9つのセキュリティスキャナーをローカルで実行：

• コードベースをスキャン
• Markdownレポートを生成
• 100%オフライン - インターネット不要
• 100%無料 - 制限なし

AI拡張レビュー（あなたの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

仕組み：

1. GuardScanがコードをローカルで分析
2. 匿名化されたコンテキストをあなたのAIプロバイダーに送信（あなたのAPIキーを使用）
3. AIが洞察と提案を提供
4. レポートはローカルに保存

あなたがAIプロバイダーに直接お支払いします - GuardScanは無料です！

---

💰 料金

GuardScan: $0（100%無料）

クレジットシステムなし。サブスクリプションなし。ペイウォールなし。

AIプロバイダー（AI機能を使用する場合）

プロバイダーに直接お支払いいただきます（GuardScanではありません）：

• OpenAI GPT-4: 1Kトークンあたり約$0.01-0.03
• Claude Sonnet: 1Kトークンあたり約$0.003
• Gemini Pro: 無料枠あり
• Ollama: 100%無料（ローカルで実行）

10K LOCのコードベースのコスト例：

• 静的解析のみ: $0
• OpenAI GPT-4使用時: 約$2-5（OpenAIに支払い）
• Ollama使用時（ローカル）: $0

---

🏗️ アーキテクチャ

GuardScanはプライバシー最優先のクライアントサイドアーキテクチャを採用しており、すべてのコード分析はローカルで実行されます。