ggshield plugin install

Description

Download and install a plugin.

ggshield plugin install [OPTIONS] PLUGIN_SOURCE

Install from GitGuardian (requires authentication):

ggshield plugin install machine_scan

ggshield plugin install machine_scan --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

Multi-user or scheduled hosts:

A per-user install places ggshield under the installing user's home, which other users — including root and cron/systemd jobs — may not be able to reach. To run scans as another user or on a schedule, install and enable as that user, or use a system-wide install.

Options

• --version TEXT: Specific version to install (GitGuardian API only)
• --sha256 TEXT: Expected SHA256 checksum for URL verification
• --allow-unsigned: Allow installing plugins without valid signatures (overrides strict mode)

This command supports all ggshield global options.