内容
<h1 align="center"><code></code></h1>
<p align="center">
查看并工具可以读取的内容。<br>
为终端、CI和macOS提供本地优先的隐私检查 - 在Claude Code、Codex、Cursor或Windsurf查看您的上下文之前。
</p>
<p align="center">
<a href="https://offsend.io">官网</a> ·
<a href="#快速入门">快速入门</a> ·
<a href="docs">文档</a> ·
<a href="https://check.offsend.io">检查</a> ·
<a href="https://offsend.io/extension">扩展</a>
</p>
<p align="center">
<a href="https://github.com/Offsend/Offsend/actions/workflows/ci.yml"><img src://github.com/Offsend/Offsend/actions/workflows/ci.svg" alt="CI"></a>
<a href="https.com/Offsend/Offsend/releases"><img src="https://.io/github/v/release/Offsend/Offsend?label=release="发布版本"></a>
<a href="LICENSE"><imghttps://img.shields.io/badge/license-Apache%202.0" alt="许可证"></a>
<img src="https://img/badge/Linux-CLI%20(x86_64%20C%20arm64)-FCClogo=linux&logoblack" alt="Linux CLI <a href="https://.com/macos/"><img src="https://img.shields.io/badgeOS%2013%2000000?logo=apple&logo" alt="平台"></ <img src="https://img.shields.io/badge/local--es-2ea44f" alt="本地优先">
<a href="https://radar.off/participants/"><img src="https://radar.offsend.io/badge.svg="AI上下文审查" height="20"></a>
</p align="center">
<img src="assets/cli.gif" alt="Offsend CLI:查看AI工具可以读取的内容" width="100%">
</p>
---
`.gitignore` 保护Git。它不定义AI工具应该读取的内容。
Offsend在敏感数据到达AI工具之前添加了一个**本地**审查步骤 - 无需云账户,无需上传文件分析。CLI是免费且开源的。
尚未安装?[扫描公共GitHub仓库进行检查](https://check.offsend.io)。
## Offsend的作用
| 层级 | 任务 | 命令 |
| --- | --- | --- |
| **边界** | 显示AI可以看到的敏感使用忽略文件隐藏它们 | `show`、`protect`、`prepare`、`ignore` |
| ** | 扫描文件、暂存差异或标准输入以查找自定义术语 | `check` |
运行时** | 控制编辑器中的提示、文件读取、MCP调用和Cursor子代理;审计本地代理历史记录 | `hook install`、`history` |
深度防御:首先使用忽略文件,然后使用钩子。钩子不能替代将密钥排除在工作区之外 - 请参阅[钩子涵盖的内容](docs/cli.md#钩子涵盖的内容)。
## 快速入门
```bash
curl -fsSL https://install.offsend.io/cli | bash
offsend doctor
offsend show
```
当暴露敏感路径时:
```text
扫描:/path/to/project
3个文件将被发送到AI工具(2个必需,1个推荐):
✗ 环境文件 [必需]
忽略.env和.env.*文件。
- .env
✗ PEM密钥 [必需]
忽略PEM密钥文件。
- server.pem
的 onboarding:
```bash
init --template node # .offsend.yml + 基线检查
offsend protect AI中隐藏必需路径
show # 验证边界(+ MCP / 历史记录提示)
offsend hook install # git pre-commit + AI编辑器门控
```
其他安装方式:[CLI文档 → 安装](docs/cli.md#安装) · macOS应用:`brew install --cask offsend/tap/offsend`
## 选择您的工具
| 工具 | 最适合 |
| --- | --- |
| **[CLI](docs/cli.md)** | 仓库、git钩子、AI编辑器门控、CI(macOS和Linux) |
| **[macOS应用](docs/macos-app.md)** | 安全粘贴、拖放准备、监视文件夹 |
| **[检查](https://check.offsend.io)** | 一次扫描公共GitHub仓库 |
| **[GitHub Actions](https://offsend.io/github-action)** | 每次PR / push进行相同检查 |
| **[扩展](https://offsend.io/extension)** | 在ChatGPT、Claude、Gemini和类似聊天中屏蔽密钥 |
## CLI基础知识
| 命令 | 用途 |
| --- | --- |
| `offsend show` | AI可见的敏感路径(+ MCP库存,代理历史记录提示) |
| `offsend protect` | 创建AI忽略文件并隐藏必需的暴露 |
| `offsend check` | 扫描内容(文件、`--staged`、标准输入或编辑器钩子JSON) |
| `offsend hook install` | git pre-commit + 提示 / 读取 / shell / MCP / 子代理门控 |
| `offsend history audit` | 在本地Cursor/Claude转录中找到已写入的密钥 |
| `offsend doctor` | 验证安装、钩子、MCP策略、下一个设置步骤 |
```bash
# CI
- uses: Offsend/ai-hygiene@v1
with:
fail-on: block
```
完整参考:**[docs/cli.md](docs/cli.md)** · 配置:**[docs/configuration.md](docs/configuration.md)**
## 隐私
- 扫描和审计在您的机器上运行。
- Offsend不会上传扫描的文件内容、提示、剪贴板有效载荷或发现结果。
- 检查仅分析您选择的GitHub仓库。
详细信息和漏洞报告:[docs/faq.md](docs/faq.md) · [SECURITY.md](SECURITY.md)。
## 文档
| 文档 | 描述 |
| --- | --- |
| [docs/README.md](docs/README.md) | 文档索引 |
| [docs/cli.md](docs/cli.md) | 命令、标志、退出代码、AI编辑器钩子 |
| [docs/configuration.md](docs/configuration.md) | `.offsend.yml` 参考(`check`、`hooks`、`context`) |
| [docs/macos-app.md](docs/macos-app.md) | 桌面应用、免费与专业、应用与CLI |
| [docs/faq.md](docs/faq.md) | 常见问题 |
| [.offsend.yml.example](.offsend.yml.example) | 注释配置启动器 |
## 贡献
欢迎提交错误报告、功能请求、文档改进和拉取请求。
- 打开一个[问题](https://github.com/Offsend/Offsend/issues)
- 在报告漏洞之前请阅读[SECURITY.md](SECURITY.md)
- 保持更改集中并解释它们解决的用户问题
## 许可证
Apache 2.0 - 请参阅[LICENSE](LICENSE)。