Installation

Linux and macOS

Run the installer script in your terminal:

curl -fsSL https://github.com/godotneers/ggg/releases/latest/download/ggg-installer.sh | sh

This downloads and runs a shell script that installs the ggg binary and a companion ggg-update binary into ~/.cargo/bin/. If that directory is not already on your PATH, the installer will print a reminder.

Supported platforms

Windows

Run the installer script in PowerShell:

irm https://github.com/godotneers/ggg/releases/latest/download/ggg-installer.ps1 | iex

This installs ggg.exe and ggg-update.exe into %USERPROFILE%\.cargo\bin\. If that directory is not already on your PATH, the installer will print a reminder.

Supported platforms

Verifying the installation

After installation, open a new terminal and run:

ggg --version

Updating

A ggg-update binary is installed alongside ggg. Run it at any time to update to the latest release:

ggg-update          # Linux / macOS
ggg-update.exe      # Windows

ggg-update fetches the latest release from GitHub and replaces the installed ggg binary in place. Your ggg.toml files and cache are not affected.

Manual installation

Pre-built archives for all supported platforms are attached to every GitHub release. Download the archive for your platform, extract it, and place the ggg binary somewhere on your PATH.

Uninstalling

Delete the ggg and ggg-update binaries from your install directory (~/.cargo/bin/ on Linux and macOS, %USERPROFILE%\.cargo\bin\ on Windows). The shared cache can be removed separately if you want to free disk space. See the cache reference for per-platform locations and what the cache contains.