ggshield (GitGuardian)

---

[ggshield](https://github.com/GitGuardian/ggshield): protect your code with 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` is a CLI application that runs in your local environment or in a CI environment to help you detect more than 500+ types of secrets.

`ggshield` uses our [public API](https://api.gitguardian.com/docs) through [py-gitguardian](https://github.com/GitGuardian/py-gitguardian) to scan and detect potential vulnerabilities in files and other text content.

Only metadata such as call time, request size and scan mode is stored from scans using `ggshield`, therefore secrets will not be displayed on your dashboard and **your files and secrets won't be stored**.

Table of Contents

• Installation
  • macOS
    • Homebrew
    • Standalone .pkg package
  • Linux
    • Deb and RPM packages
  • Windows
    • Chocolatey
    • Standalone .zip archive
  • All operating systems
    • Using pipx
    • Using pip
• Initial setup
  • Using `ggshield auth login`
  • Manual setup
• Getting started
  • Secrets
• Integrations
• Learn more
• Output
• Related open source projects
• License

Installation

macOS

Homebrew

You can install `ggshield` using Homebrew:

$ brew install ggshield

Upgrading is handled by Homebrew.

Standalone .pkg package

...