cognis-digital/ghaudit

``` pip install cognis-ghaudit ghaudit scan . # → prioritized findings in seconds ``` ## 使用说明 — 逐步指南 1. 安装 (Python 3.9+)： pip install ghaudit 2. 通过导出的 JSON 文件审计 GitHub 组织的安全态势（分支 规则、2FA、secrets — 仅用于防御性分析）： ghaudit audit org-export.json 3. 生成独立的 HTML 或 JSON 报告，而不是控制台表格： ghaudit audit org-export.json --format html -o ghaudit-report.html ghaudit audit org-export.json --format json -o ghaudit-report.json 4. 阅读输出结果：表格按严重程度总结了发现的问题。如需自动化操作， 请解析 `--format json` 报告。当存在任何 CRITICAL/HIGH（失败）的发现时，进程退出码为 `1`，否则为 `0`。 5. 根据组织态势控制 CI 准入： ghaudit audit org-export.json --format json -o report.json ## 目录 - [为什么选择 ghaudit？](#why) · [功能](#features) · [快速开始](#quick-start) · [示例](#example) · [架构](#architecture) · [AI 技术栈](#ai-stack) · [对比](#how-it-compares) · [集成](#integrations) · [随处安装](#install-anywhere) · [相关项目](#related) · [贡献指南](#contributing) ## 为什么选择 ghaudit？ 通过导出的文件审计 GitHub 组织的安全态势（分支规则、2FA、secrets）— 无需搭建重量级的基础设施。 `ghaudit` 具有单一用途、可脚本化且支持自托管：将其指向目标，即可根据您工作流所使用的格式（表格 · JSON · SARIF）获取优先级排序的结果，将其用于控制 CI 准入，并允许 agent 通过 MCP 进行驱动。 ## 功能 - ✅ 加载导出文件 - ✅ 审计组织 - ✅ 渲染 Json - ✅ 渲染表格 - ✅ 渲染 Html - ✅ 运行于 Linux/macOS/Windows · Docker · devcontainer - ✅ 提供 Python、JavaScript、Go 和 Rust 版本 (`ports/`) ## 快速开始 ``` pip install cognis-ghaudit ghaudit --version ghaudit scan . # scan current project ghaudit scan . --format json # machine-readable ghaudit scan . --fail-on high # CI gate (non-zero exit) ``` ## 示例 ``` $ ghaudit scan . [HIGH ] GHA-001 example finding (./src/app.py) [MEDIUM ] GHA-002 another signal (./config.yaml) 2 findings · risk score 5 · 38ms ``` ## 架构 ``` flowchart LR IN[target / export] --> P[ghaudit
collect + correlate] P --> OUT[ranked findings] ``` ## 从任何 AI 技术栈中使用 `ghaudit` 可与所有流行的 AI 使用方式互操作： - **MCP 服务器** — `ghaudit mcp` (Claude Desktop, Cursor, Cognis.Studio, [uncensored-fleet](https://github.com/cognis-digital/uncensored-fleet)) - **兼容 OpenAI / JSON** — 通过管道将 `ghaudit scan . --format json` 输出传递给任何 agent 或 LLM - **LangChain · CrewAI · AutoGen · LlamaIndex** — 一行代码即可将 CLI/JSON 封装为工具 - **CI / 脚本** — 为非 AI 流水线提供退出码 + SARIF ## 对比 | | **Cognis ghaudit** | 典型工具 | |---|:---:|:---:| | 支持自托管，无需账号 | ✅ | 视情况而定 | | 单条命令，零配置 | ✅ | ⚠️ | | 用于 CI 的 JSON + SARIF | ✅ | 视情况而定 | | MCP 原生支持 (AI agent) | ✅ | ❌ | | 多语言移植版本 (JS/Go/Rust) | ✅ | ❌ | | 开放许可证 | ✅ COCL | 视情况而定 | ## 集成 融入您的技术栈：用于代码扫描的 **SARIF**，用于一切的 **JSON**，用于 AI agent 的 **MCP 服务器** (`ghaudit mcp`)，以及用于 SIEM/Slack/Jira 的 webhook 转发器。详见 [`docs/INTEGRATIONS.md`](docs/INTEGRATIONS.md)。 ## 安装 — 各种方式，所有平台 ``` pip install "git+https://github.com/cognis-digital/ghaudit.git" # pip (works today) pipx install "git+https://github.com/cognis-digital/ghaudit.git" # isolated CLI uv tool install "git+https://github.com/cognis-digital/ghaudit.git" # uv pip install cognis-ghaudit # PyPI (when published) docker run --rm ghcr.io/cognis-digital/ghaudit:latest --help # Docker brew install cognis-digital/tap/ghaudit # Homebrew tap curl -fsSL https://raw.githubusercontent.com/cognis-digital/ghaudit/main/install.sh | sh ``` | Linux | macOS | Windows | Docker | 云平台 | |---|---|---|---|---| | `scripts/setup-linux.sh` | `scripts/setup-macos.sh` | `scripts/setup-windows.ps1` | `docker run ghcr.io/cognis-digital/ghaudit` | [DEPLOY.md](docs/DEPLOY.md) (AWS/Azure/GCP/k8s) | ## 相关的 Cognis 工具 **探索套件 →** [🗂️ 全部 170+ 工具](https://github.com/cognis-digital/cognis-neural-suite) · [⭐ awesome-cognis](https://github.com/cognis-digital/awesome-cognis) · [🔗 cognis-sources](https://github.com/cognis-digital/cognis-sources) · [🤖 uncensored-fleet](https://github.com/cognis-digital/uncensored-fleet) · [🧠 engram](https://github.com/cognis-digital/engram) ## 互操作性 `{}` 与包含 300+ 工具的 Cognis 套件无缝组合 — JSON 输入/输出以及兼容 OpenAI 的 `/v1` 主干网络。请参阅 **[INTEROP.md](INTEROP.md)** 获取 套件图谱、组合模式和参考技术栈。 ## 许可证 源代码可见，基于 **Cognis Open Collaboration License (COCL) v1.0** — 可免费用于个人、内部评估、研究和教育用途；**商业/生产用途需要获得许可证** (licensing@cognis.digital)。请参阅 [LICENSE](LICENSE)。

标签：DevSecOps, Python, 上游代理, 可视化界面, 安全态势, 数据可视化, 无后门, 日志审计, 请求拦截, 逆向工具, 配置合规