Installation

Git-Iris requires Git 2.23.0+ and an API key for your chosen LLM provider.

Prerequisites

Requirement	Version	Notes
Git	2.23.0+	Check with git --version
Rust (Cargo install)	Latest stable	Get from rustup.rs
LLM API Key	—	OpenAI, Anthropic, or Google

Installation Methods

Quick Install (Recommended)

The fastest way to get Git-Iris on macOS or Linux:

curl -fsSL https://raw.githubusercontent.com/hyperb1iss/git-iris/main/install.sh | sh

This downloads a pre-built binary and installs it to ~/.local/bin by default. Make sure that directory is on your PATH.

Customize the install with environment variables:

Variable	Default	Description
IRIS_INSTALL_DIR	~/.local/bin	Where to drop the git-iris binary
IRIS_VERSION	latest	Pin to a specific release tag (e.g. v1.4.0)

# Pin a specific version and install system-wide
curl -fsSL https://raw.githubusercontent.com/hyperb1iss/git-iris/main/install.sh \
  | IRIS_INSTALL_DIR=/usr/local/bin IRIS_VERSION=v1.4.0 sh

Via Homebrew (macOS / Linux)

brew tap hyperb1iss/tap
brew install git-iris

Pulls pre-built binaries from the hyperb1iss/homebrew-tap and keeps them updated alongside other Homebrew packages.

Via Cargo

cargo install git-iris

This installs the latest stable release from crates.io. Use this when you have a Rust toolchain installed and want to compile from source.

Verify installation:

git-iris --version

Via Docker

Pull the official image:

docker pull hyperb1iss/git-iris:latest

Run in your repository:

docker run --rm -v "$(pwd):/git-repo" hyperb1iss/git-iris gen

With environment variables:

docker run --rm -v "$(pwd):/git-repo" \
  -e OPENAI_API_KEY="your-api-key" \
  hyperb1iss/git-iris gen --provider openai

Persistent configuration:

docker run --rm -v "$(pwd):/git-repo" \
  -v git-iris-config:/root/.config/git-iris \
  hyperb1iss/git-iris config --provider openai --api-key your-api-key

Docker is excellent for CI/CD workflows—no installation required on your build agents.

Manual Build

Clone and build from source:

git clone https://github.com/hyperb1iss/git-iris.git
cd git-iris
cargo build --release
cargo install --path .

The release binary will be in target/release/git-iris and installed to your Cargo bin directory.

Platform-Specific Notes

macOS

If using Homebrew's Git, ensure it's up to date:

brew upgrade git

Linux

Most distributions ship recent Git versions. If yours is outdated:

# Debian/Ubuntu
sudo add-apt-repository ppa:git-core/ppa
sudo apt update && sudo apt install git

# Fedora/RHEL
sudo dnf install git

Windows

Git-Iris works in WSL2, Git Bash, or PowerShell. We recommend WSL2 for the best experience, especially with Studio's TUI features.

Verify Installation

Check that Git-Iris is properly installed:

git-iris --version

You should see version information and the build metadata.

What's Next?

Head to Configuration to set up your API key, or jump straight to the Quick Start to generate your first AI commit.