Skip to content

Installation

git-spice may be installed with a pre-built binary or built from source.

System requirements

  • Operating system: Linux and macOS are fully supported. Windows support was added in v0.6.0.

  • Architecture: x86_64 and aarch64 architectures are supported. Additionally on Linux, some 32-bit ARM architectures are also supported.

  • Git: At least Git 2.38 is required for git-spice to operate correctly. Earlier versions may work, but are not officially supported.

Pre-built binary

To install a pre-built binary, use one of the following methods:

Homebrew/Linuxbrew

git-spice is available in homebrew-core (the default formulae repository for Homebrew and Linuxbrew). Install git-spice with the following command:

brew install git-spice

You can also use my Homebrew Tap to install the latest release:

brew install --cask abhinav/tap/git-spice

Binary installation tools

ubi

ubi is a binary installation tool that is able to download pre-built binaries from GitHub Releases.

If you use ubi, use the following command to install git-spice:

ubi --project abhinav/git-spice --exe git-spice

mise

mise supports installing tools from various sources, including directly from GitHub.

If you use mise, use the following command to install git-spice:

mise use --global 'github:abhinav/git-spice'

AUR (ArchLinux)

If you're using ArchLinux, install the 'git-spice-bin' package from the AUR:

git clone https://aur.archlinux.org/git-spice-bin.git
cd git-spice-bin
makepkg -si

# Or, with an AUR helper like yay:
yay -S git-spice-bin

Ubuntu PPA

Unreleased

If you're using Ubuntu, install git-spice from the official PPA:

sudo add-apt-repository ppa:abhg/git-spice
sudo apt update
sudo apt install git-spice

Linux packages

v0.27.0

GitHub Releases also provides native Linux packages:

  • .deb packages for Debian and Ubuntu
  • .rpm packages for Fedora, RHEL, Rocky, AlmaLinux, and openSUSE
  • .apk packages for Alpine

Download the package for your architecture from the GitHub Releases page, then install it with your system package manager:

sudo apt install ./git-spice_<version>_<arch>.deb

sudo dnf install ./git-spice-<version>-1.<arch>.rpm

sudo zypper install ./git-spice-<version>-1.<arch>.rpm

sudo apk add --allow-untrusted ./git-spice-<version>-r1.<arch>.apk

Manual download

You can manually download the latest release of git-spice from the GitHub Releases page.

Build from source

To build from source, follow these steps:

  1. Install the Go compiler.

  2. Run the following command:

    go install go.abhg.dev/gs@latest

The canonical command name is git-spice, but most examples in this documentation use gs for brevity. Add a shell alias so both forms work:

alias gs=git-spice

alias gs git-spice

Next steps