Nano-Collective/sentinel
GitHub: Nano-Collective/sentinel
Sentinel 是一个由 Nanocoder 驱动、本地优先的 GitHub 组织级代码审计工作流工具,通过可自定义的 rule pack 持续扫描代码库并将发现提交为 issue。
Stars: 1 | Forks: 0
# Sentinel
由 [Nano Collective](https://nanocollective.org) 构建 —— 这是一个社区集合组织,构建 AI 工具的初衷不是为了盈利,而是为了社区。
Sentinel 是一个可安装的、由 Nanocoder 驱动的工作流,它会对 GitHub 组织中的代码库运行持续的、可配置的安全和代码审计,并将其发现的问题作为 issue 提交给人工处理。
你可以将 Sentinel 安装到你自己的组织中,将其指向你关心的代码库,编写用于描述需要查找内容的 rule pack,然后由预定的 GitHub Actions 工作流来执行审计。审计发现会作为 issue 出现在受影响的代码库中,并为审查者整理好报告。本地模型是首选方案,因此被审计的代码绝不需要离开你自有的硬件。






## 快速开始
在你的 GitHub 组织内的一个全新代码库中:
```
npx @nanocollective/sentinel init
# 或
pnpm dlx @nanocollective/sentinel init
```
`init` 会搭建配置文件 (`sentinel.yaml`)、预定的 GitHub Actions 工作流、一个空的 `rule-packs/` 目录以及一个入门 pack 模板。回答提示问题(模型提供商、时间表、首批代码库),检查生成的文件,编写你的第一个 rule pack,然后提交并推送。首次预定运行会在当天晚些时候进行,你也可以手动触发该工作流。
Sentinel **自身不附带任何 rule pack**。其价值源于你为自己实际交付的代码所编写的 pack —— 参见 [编写 Rule Pack](docs/rule-packs/authoring.md)。
你还可以在本地运行审计(非周期性),以便校准 pack:
```
npx @nanocollective/sentinel run \
--rule-pack ./rule-packs/solana-anchor.md \
--repo ../my-program \
--output findings.md
```
## 文档
完整的在线文档可在 **[docs.nanocollective.org](https://docs.nanocollective.org/sentinel/docs)** 或 [docs/](docs/) 文件夹中找到:
- **[入门指南](docs/getting-started/index.md)** — 将 Sentinel 安装到你的组织中,并确保首次运行成功
- **[Rule Packs](docs/rule-packs/index.md)** — pack 格式、编写指南和实例
- **[配置](docs/configuration/index.md)** — `sentinel.yaml` 参考
- **[工作流](docs/workflow/index.md)** — 预定审计、运行模式和执行模型
- **[发现与 Issues](docs/findings/index.md)** — 严重程度模型、issue 提交、去重和抑制
- **[CLI](docs/cli/index.md)** — `init` 和 `run` 命令参考
- **[社区](docs/community.md)** — 贡献、Discord 以及如何提供帮助
## Sentinel 不是什么 (在 v1 版本中)
Sentinel 是一个分流层,而不是真正审计的替代品。它**不是**正式安全审计的替代方案,**不是** SAST 的替代品(请与 Semgrep/CodeQL 配合使用),**不是**密钥扫描器,**不是**托管服务,**不是** rule pack 目录,也**不是**修复工具 —— 它只负责提交 issue,而不会发起 PR。完整的范围说明请参见 [白皮书](https://docs.nanocollective.org/collective/whitepapers/sentinel)。
## 社区
Nano Collective 是一个为社区构建 AI 工具(而非为盈利)的社区集合组织。我们期待你的帮助。
- **贡献**:请参阅 [CONTRIBUTING.md](CONTRIBUTING.md) 了解开发设置和指南。
- **该集合组织**:[nanocollective.org](https://nanocollective.org) · [文档](https://docs.nanocollective.org) · [GitHub](https://github.com/Nano-Collective) · [Discord](https://discord.gg/ktPDV6rekE)
- **支持这项工作**:[支持页面](https://docs.nanocollective.org/collective/organisation/support) 介绍了捐赠和赞助方式。
- **有偿贡献**:[经济学章程](https://docs.nanocollective.org/collective/organisation/economics-charter) 说明了范围明确的有偿悬赏是如何运作的。
标签:GitHub Actions, MITM代理, 云安全监控, 对称加密, 暗色界面, 本地大模型, 自动化审计, 自动化攻击, 自动笔记, 静态分析