Skip to main content

ggshield plugin install

Description

Download and install a plugin.

ggshield plugin install [OPTIONS] PLUGIN_SOURCE

Install from GitGuardian (requires authentication):

ggshield plugin install tokenscanner

ggshield plugin install tokenscanner --version 0.1.0

Install from a local wheel file:

ggshield plugin install ./path/to/plugin.whl

Install from a URL:

ggshield plugin install https://example.com/plugin.whl

ggshield plugin install https://example.com/plugin.whl --sha256 abc123...

Install from a GitHub release:

ggshield plugin install https://github.com/owner/repo/releases/download/v1.0.0/plugin.whl

Install from a GitHub Actions artifact (requires GITHUB_TOKEN):

ggshield plugin install https://github.com/owner/repo/actions/runs/123/artifacts/456

Options

  • --version TEXT: Specific version to install (GitGuardian API only)
  • --sha256 TEXT: Expected SHA256 checksum for URL verification
  • --force: Skip security warnings for non-GitGuardian sources

This command supports all ggshield global options.