GitGuardian/ggshield
GitHub: GitGuardian/ggshield
一款用于在代码提交与 CI 流程中检测并阻止硬编码密钥的 CLI 与集成工具。
Stars: 1937 | Forks: 193
# [ggshield](https://github.com/GitGuardian/ggshield): 使用 GitGuardian 保护您的代码
[](https://pypi.org/project/ggshield/)
[](https://hub.docker.com/r/gitguardian/ggshield)
[](LICENSE)
[](https://github.com/GitGuardian/ggshield/stargazers)
[](https://github.com/GitGuardian/ggshield/actions)
[](https://codecov.io/gh/GitGuardian/ggshield/)
`ggshield` 是一个 CLI 应用程序，运行在本地环境或 CI 环境中，帮助您检测 500 多种类型的密钥。
`ggshield` 通过我们的 [公共 API](https://api.gitguardian.com/docs) 和 [py-gitguardian](https://github.com/GitGuardian/py-gitguardian) 来扫描和检测文件及其他文本内容中的潜在漏洞。
仅从扫描中存储元数据，例如调用时间、请求大小和扫描模式，因此密钥不会显示在您的仪表板上，**您的文件和密钥不会被存储**。
# 目录
- [安装](#installation)
- [macOS](#macos)
- [Homebrew](#homebrew)
- [独立 .pkg 包](#standalone-pkg-package)
- [Linux](#linux)
- [Deb 和 RPM 包](#deb-and-rpm-packages)
- [Windows](#windows)
- [Chocolatey](#chocolatey)
- [独立 .zip 压缩包](#standalone-zip-archive)
- [所有操作系统](#all-operating-systems)
- [使用 pipx](#using-pipx)
- [使用 pip](#using-pip)
- [初始设置](#initial-setup)
- [使用 `ggshield auth login`](#using-ggshield-auth-login)
- [手动设置](#manual-setup)
- [开始使用](#getting-started)
- [密钥](#secrets)
- [集成](#integrations)
- [了解更多](#learn-more)
- [输出](#output)
- [相关开源项目](#related-open-source-projects)
- [许可证](#license)
# 安装