Install gat
- macOS / Linux
- Windows PowerShell
gat is installed to ~/.local/bin on macOS/Linux and
%USERPROFILE%\.local\bin on Windows. The installer tells you if that
directory is not currently on your PATH.Verify the installation
gat is installed and ready to use.Continue with your first repository
gat works inside Git repositories. Continue to the
Quickstart to initialize a repository, track a file, and
push it to storage.To use the docs from your AI assistant, follow
Use Gat MCP in AI tools.Installation options
Choose an option for a pinned version, custom location, or source build.Installer requirements and recovery
Installer requirements and recovery
sh, Bash 3.2+, curl, tar,
awk, grep, uname, mktemp, mkdir, rm, install, mv, cat,
sleep, and sha256sum or shasum. Linux uses getconf when available
to detect glibc; missing or unrecognized detection selects static musl.
On Alpine, install the prerequisites with apk add bash curl if needed.Downloads need HTTPS access to GitHub and a working certificate store.
The installer verifies and runs the new binary before replacing an existing
installation. A failed download or compatibility check leaves it in place.
If the new binary cannot start, the installer also prints its startup error.The destination must be a regular file or absent, not a directory or symlink.
On Windows, close running Gat processes if the executable is locked.Install a specific version
Pin gat for CI, reproducible environments, or controlled upgrades.
Install a specific version
Pin gat for CI, reproducible environments, or controlled upgrades.
0.1.0 and v0.1.0 are accepted.- macOS / Linux
- Windows PowerShell
GAT_VERSION environment variable before running the
installer.Choose a Linux libc build
Use automatic selection or explicitly choose GNU or static musl.
Choose a Linux libc build
Use automatic selection or explicitly choose GNU or static musl.
--libc auto is the default. The installer prints its selection:--libc gnu explicitly selects GNU. Overrides still undergo the startup
check; selecting GNU does not make an incompatible binary runnable.
--libc gnu and --libc musl are Linux-only. Combine either with
--version to pin the release.Change the install directory
Install gat somewhere other than the default user-local bin directory.
Change the install directory
Install gat somewhere other than the default user-local bin directory.
GAT_INSTALL_DIR before running the installer.- macOS / Linux
- Windows PowerShell
PATH.Download a release manually
Choose an archive yourself and verify it before installing.
Download a release manually
Choose an archive yourself and verify it before installing.
SHA256SUMS file containing the SHA-256 checksum
of every platform archive.- macOS / Linux
- Windows PowerShell
x86_64-unknown-linux-musl. Change the architecture
and platform as needed.Verify build provenance
Confirm that a release archive was produced by gat's GitHub Actions release workflow.
Verify build provenance
Confirm that a release archive was produced by gat's GitHub Actions release workflow.
.zip archive instead.Build and install from source
Use Cargo when a prebuilt binary is not suitable for your environment.
Build and install from source
Use Cargo when a prebuilt binary is not suitable for your environment.
gat is not currently published to crates.io. Install it directly from
the Git repository:Install from a local checkout
Useful when developing gat itself.
Install from a local checkout
Useful when developing gat itself.
gat to Cargo’s binary directory, usually
~/.cargo/bin.
