ghr Get started

ghr documentation

Detailed guides and command reference for ghr. For a project overview, see the top-level README.

New to ghr? Follow Getting started to install ghr and your first tool.

Topics

  • Usage — command syntax and examples.
  • Install — install ghr and uninstall it.
  • Examples — install and manage tools from the command line.
  • Download — fetch, extract, authenticate, and verify release assets.
  • Caching in GitHub Actions — cache ghr installs and downloads in workflows.
  • Directories — default directories and ghr path add behavior.
  • WSL linking — expose Windows-side tools inside WSL.
  • Troubleshooting — Linux name-resolution fallback for long resolv.conf files.
  • Verification — verifier behavior, trust roots, skip flags, and recorded results.
  • Reproducible builds — release archive reproducibility and Authenticode stripping.

Design and implementation

  • Install identifiers — stable install IDs, explicit command aliases, versioned state, and lazy migration, implemented since v0.8.0.

Install

Install ghr with the shell or PowerShell bootstrap, or a package manager; see Install.

Usage

See Usage for the command overview, install source syntax, and examples.

Download

Download one or more GitHub release assets, optionally extracting archives; see Download.

Caching in GitHub Actions

Cache installed tools or downloaded assets in workflows; see Caching in GitHub Actions, actions/setup, actions/install, and actions/download.

Directories

ghr follows uv-style directory conventions and supports environment overrides; see Directories.

WSL: linking Windows-side bins (ghr link / ghr unlink)

Expose Windows-side installs and selected Windows PATH executables inside WSL; see WSL linking.

Name resolution on Linux

ghr includes a fallback DNS path for oversized WSL-generated resolv.conf files; see Name resolution on Linux.

Uninstall

Uninstall ghr from the package manager that installed it; see Uninstall.

Verification

Review automatic verification, skip/failure behavior, trust roots, and recorded install results in Verification.

Reproducible builds

Linux and macOS release archives are byte-reproducible, and Windows builds are checked after stripping Authenticode signatures; see Reproducible builds.

View Markdown source