OS Manuals

/usr/share/ggshield/bin/unearth

Find and fix 360+ types of hardcoded secrets and 70+ types of infrastructure-as-code misconfigurations.

From ggshield 1.55.0-r6 (os), captured 2026-11-07 by running unearth --help (exit 0). permalink

usage: unearth [-h] [--requirements FILE] [--verbose] [--index-url URL] [--find-link LOCATION]
               [--trusted-host HOST] [--no-binary] [--only-binary] [--prefer-binary] [--all]
               [--link-only] [--download [DIR]] [--python-version PY_VER] [--abis ABIS]
               [--implementation IMPL] [--platforms PLATFORMS]
               [requirement]

Find and download packages from a PEP 508 requirement string.

positional arguments:
  requirement           A PEP 508 requirement string, e.g. 'requests>=2.18.4'.

options:
  -h, --help            show this help message and exit
  --requirements FILE, -r FILE
                        Read PEP 508 requirements from a UTF-8 file, one per line.
  --verbose, -v         Enable verbose logging.
  --index-url URL, -i URL
                        (Multiple)(PEP 503)Simple Index URLs.
  --find-link LOCATION, -f LOCATION
                        (Multiple)URLs or locations to find links from.
  --trusted-host HOST   (Multiple)Trusted hosts that should skip the verification.
  --no-binary           Exclude binary packages from the results.
  --only-binary         Only include binary packages in the results.
  --prefer-binary       Prefer binary packages even if sdist candidates of newer versions exist.
  --all                 Return all applicable versions.
  --link-only, -L       Only return links instead of a JSON object.
  --download [DIR], -d [DIR]
                        Download the package(s) to DIR.

Target Python options:
  --python-version PY_VER, --py PY_VER
                        Target Python version. e.g. 3.11.0
  --abis ABIS           Comma-separated list of ABIs. e.g. cp39,cp310
  --implementation IMPL, --impl IMPL
                        Python implementation. e.g. cp,pp,jy,ip
  --platforms PLATFORMS
                        Comma-separated list of platforms. e.g. win_amd64,linux_x86_64
Options (10)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
--verbose, -vEnable verbose logging.help
--trusted-host HOST(Multiple)Trusted hosts that should skip the verification.help
--no-binaryExclude binary packages from the results.help
--only-binaryOnly include binary packages in the results.help
--prefer-binaryPrefer binary packages even if sdist candidates of newer versions exist.help
--allReturn all applicable versions.help
--link-only, -LOnly return links instead of a JSON object.help
--abis ABISComma-separated list of ABIs.help
--platforms PLATFORMSComma-separated list of platforms.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.