Argus

🚀 Argus - 代碼倉庫分析與安全評估工具

Argus 是一款強大的模型上下文協議（MCP）工具，它能夠對代碼倉庫進行分析，執行安全性掃描，並評估多種編程語言的代碼質量，為開發者提供全面的代碼審查和安全保障。

🚀 快速開始

Argus 是一個功能強大的工具，可用於分析代碼倉庫、執行安全性掃描以及評估多種編程語言的代碼質量。下面為你介紹其快速上手的步驟。

✨ 主要特性

多語言支持

• Go：支持 gocyclo、golangci-lint 分析。
• Java：可進行 PMD 靜態分析。
• Python：能使用 Pylint、Bandit 進行安全檢查。
• JavaScript/TypeScript：支持 ESLint 分析。
• 具備自動語言檢測功能。

安全性掃描

• 集成 Trivy 漏洞掃描器，可進行全面的漏洞檢測。
• 生成全面的安全性報告，讓安全問題一目瞭然。
• 支持對多個分支進行掃描。

Git 操作

• 可進行分支枚舉與管理，清晰掌握倉庫分支情況。
• 能分析提交歷史，瞭解代碼的演變過程。
• 支持差異比較，方便查看不同版本間的代碼變化。
• 可將倉庫結構可視化，直觀呈現倉庫的組織架構。

📦 安裝指南

依賴項

• 需要 Python 3.8 及以上版本。
• 需安裝 Git。
• 系統依賴 libmagic。

系統依賴

macOS

brew install libmagic

Linux (Ubuntu/Debian)

sudo apt-get update
sudo apt-get install -y libmagic1

通過 uv 安裝

uvx argus

💻 使用示例

基礎用法

# 分析倉庫結構
analyze_repository_structure(
    repo_url="https://gitlab.com/user/repo",
    gitlab_credentials={"api_key": "your-token"},  # 可選
    branch="main"  # 可選
)

# 執行代碼質量分析
analyze_code_quality(
    repo_url="https://gitlab.com/user/repo",
    language="python"  # 可選，未指定時自動檢測
)

# 安全掃描
security_scan_repository(
    repo_url="https://gitlab.com/user/repo",
    scan_type="trivy"
)

# 比較更改
compare_git_changes(
    repo_url="https://gitlab.com/user/repo",
    source="feature-branch",
    target="main"
)

# 安全掃描倉庫
security_scan_repository(
    repo_url="https://gitlab.com/user/repo",
    scan_type="trivy"
)

MCP 配置

{
    "command": "uvx",
    "args": [
        "--from",
        "git+https://github.com/athapong/argus",
        "argus"
    ],
    "alwaysAllow": [
        "get_commit_history",
        "enumerate_branches",
        "compare_git_changes",
        "analyze_code_quality",
        "security_scan_repository"  
    ],
    "timeout": 300
}

📚 詳細文檔

支持的分析工具

環境變量

• SKIP_SYSTEM_CHECK：設置為任意值以跳過系統依賴檢查。
• PATH：自動更新工具安裝路徑。

錯誤處理

該工具提供詳細的錯誤消息和優雅的回退機制：

• 依賴項安裝失敗時顯示警告而非錯誤。
• 自動語言檢測失敗時回退到指定語言。
• 工具執行錯誤被捕獲在響應結構中。

📄 許可證

本項目採用 MIT License。

🤝 貢獻指南

1. 叉倉庫。
2. 創建功能分支。
3. 提交更改。
4. 推送到分支。
5. 創建新的拉取請求。