Repolode
GitGuardian

GitGuardian/ggshield

ファイル、Gitリポジトリ、Dockerイメージ、パッケージ内の500種類以上のハードコードされたシークレットを検出・検証するCLI。pre-commitフックやCIで利用できます。

スター
2,011
フォーク
221
未解決の Issue
69
最終コミット
9 時間前

これは何?

ggshieldはGitGuardianが提供するコマンドラインツールです。APIキーや認証情報などのハードコードされたシークレットが漏えいする前に検出します。ローカルファイル、Gitリポジトリ、Dockerイメージ、PyPIパッケージをスキャンでき、開発者のマシンでもCIパイプライン内でも実行できます。

GitGuardianの公開APIを呼び出してシークレットを検出・検証し、Gitのpre-commit、pre-push、pre-receiveフックやGitHub Actionsに組み込めます。スキャン時に保存されるのは呼び出し時刻、リクエストサイズ、スキャンモードなどのメタデータのみで、検出したシークレットの値がダッシュボードに保存されることはありません。

Cursor、Claude Code、Copilot Chat、CodexなどのAIコーディングアシスタントとのやり取りをスキャンするフックもインストールできます。シークレットを含むアクションは実行前にブロックされます。

主な機能

  • 01検証チェックを通じて500種類以上のシークレットを検出します。
  • 02ファイル、Gitリポジトリ、Dockerイメージ、PyPIパッケージをスキャンします。
  • 03Gitのpre-commit、pre-push、pre-receiveフックとして実行できます。
  • 04GitHub ActionとCI/CD連携を提供します。
  • 05AIコーディングアシスタントとのやり取りをスキャンするフックをインストールできます。
  • 06pip、pipx、Homebrew、またはパッケージを使ってmacOS、Linux、Windowsにインストールできます。

ユースケース

  • pre-commitフックで、シークレットがリポジトリにコミットされるのを防ぐ。
  • デプロイ前にCIパイプラインをスキャンし、漏えいした認証情報を検出する。
  • 既存のGit履歴やDockerイメージを監査し、ハードコードされたキーを探す。
  • シークレットを含むアクションをAIコーディングアシスタントが実行するのを防ぐ。

クイックスタート

  1. 1

    pipxでggshieldをインストールする(Pythonとgitが必要)

    pipx install ggshield
  2. 2

    GitGuardianサーバーに対して認証する

    ggshield auth login
  3. 3

    現在のディレクトリをスキャンしてシークレットを検出する

    ggshield secret scan path -r .

使う前に知っておきたいこと

  • スキャンにはGitGuardianサーバーでの認証が必要で、同社の公開APIを使用します。
  • PyPIからインストールする場合、サポート対象でサポート終了(EOL)になっていないバージョンのPythonとgitが必要です。
  • macOSでは、1.54.0にアップグレードすると、ggshield-pyバイナリに対するKeychainの確認プロンプトが表示されます。

収録されている特集

トピック

よくある質問

ggshield とは?
ファイル、Gitリポジトリ、Dockerイメージ、パッケージ内の500種類以上のハードコードされたシークレットを検出・検証するCLI。pre-commitフックやCIで利用できます。 ggshieldはGitGuardianが提供するコマンドラインツールです。APIキーや認証情報などのハードコードされたシークレットが漏えいする前に検出します。ローカルファイル、Gitリポジトリ、Dockerイメージ、PyPIパッケージをスキャンでき、開発者のマシンでもCIパイプライン内でも実行できます。
ggshield は無料で使えますか?ライセンスは?
ggshield は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
ggshield は今もメンテナンスされていますか?
活発にメンテナンス中。ggshield の最終コミットは 2026年11月6日 です。
ggshield は何に使えますか?
pre-commitフックで、シークレットがリポジトリにコミットされるのを防ぐ。 デプロイ前にCIパイプラインをスキャンし、漏えいした認証情報を検出する。 既存のGit履歴やDockerイメージを監査し、ハードコードされたキーを探す。 シークレットを含むアクションをAIコーディングアシスタントが実行するのを防ぐ。
ggshield のインストール方法は?
pipxでggshieldをインストールする(Pythonとgitが必要): pipx install ggshield GitGuardianサーバーに対して認証する: ggshield auth login 現在のディレクトリをスキャンしてシークレットを検出する: ggshield secret scan path -r .
ggshield はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/GitGuardian/ggshield

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト