Skip to content

Installation

Gity is distributed as a single binary that works on Linux, macOS, and Windows.

Requirements

  • Git 2.37+ — Required for fsmonitor protocol v2 support
  • Rust 1.75+ — Only if building from source

Check your Git version:

git --version
# Should be 2.37 or higher

Installation Methods

If you have Rust installed:

cargo install gity

With system tray support:

cargo install gity --features tray

Or clone and build from source:

git clone https://github.com/neul-labs/gity.git
cd gity
cargo build --release
# Binary is at ./target/release/gity
brew tap neul-labs/tap
brew install gity
npm install -g gity-cli

Or use npx without installing:

npx gity-cli register /path/to/repo
pip install gity-cli

Or with uv:

uv tool install gity-cli

Debian/Ubuntu (.deb)

Download from GitHub Releases:

wget https://github.com/neul-labs/gity/releases/latest/download/gity-<version>-x86_64-unknown-linux-gnu.tar.gz
tar -xzf gity-<version>-x86_64-unknown-linux-gnu.tar.gz
sudo cp gity /usr/local/bin/

Snap

snap install gity

Homebrew (recommended)

brew tap neul-labs/tap
brew install gity

Package Installer

Download the .pkg installer from GitHub Releases.

MSI Installer

Download the MSI installer from GitHub Releases.

Chocolatey

choco install gity

npm

npm install -g gity-cli

Verify Installation

After installation, verify Gity is working:

gity --version

Supply Chain Security

All release artifacts are built and published via GitHub Actions with OIDC-based trusted publishing and signed attestations:

Verify a release binary:

gh attestation verify gity-0.1.2-x86_64-unknown-linux-gnu.tar.gz --owner neul-labs

Next Steps

Once installed, head to the Quick Start guide to accelerate your first repository.

Uninstallation

cargo uninstall gity
brew uninstall gity
brew untap neul-labs/tap
npm uninstall -g gity-cli
pip uninstall gity-cli
sudo dpkg -r gity
snap remove gity

Run the uninstaller or remove manually:

sudo rm /usr/local/bin/gity

Use "Add or Remove Programs" in Windows Settings, or run:

msiexec /x gity.msi

Before uninstalling, make sure to unregister all repositories:

gity list
gity unregister /path/to/repo1
gity unregister /path/to/repo2
gity daemon stop

This ensures Git configuration is cleaned up properly.