Requirements

gitoui targets recent Linux and macOS terminals. Windows isn’t officially supported but should work under WSL2 with a compatible terminal.

Runtime

Tool	Version	Why
`git`	2.30+	gitoui shells out to the CLI for every git operation.
A terminal	Recent (see below)	The commit graph and avatars are rendered inline as images.
`xdg-open` / `open`	platform default	Used by the “open in browser” shortcut for PRs and issues.

Terminal image protocols

gitoui pre-renders the commit graph as images and ships them inline. To see the graph, your terminal needs to speak one of:

Protocol	recommended when…	Terminals (non-exhaustive)
Kitty	available, auto-detect default	Ghostty (recommended), Kitty, WezTerm, Konsole 22.04+, modern gnome-terminal / Ptyxis (VTE ≥ 0.78)
iTerm2	on macOS	iTerm2, WezTerm
Sixel	nothing else works	foot (Wayland), mlterm, xterm `-ti vt340`, WezTerm
Unicode	fallback in any other terminal	Alacritty, Terminal.app, Windows Terminal… (no inline images)

The same protocol drives the GitHub avatar rendering. If your terminal can show the commit graph, it can show avatars next to commits, comments, and review events.

Building from source

If you’re building locally instead of using a prebuilt binary:

Tool	Version	Notes
Rust	1.88+	`rust-toolchain.toml` not pinned, use stable.
Cargo	ships with Rust
`cc` / `cargo`-compatible linker	platform default	For native deps (`sharp` isn’t required, this is Rust only).

Once Rust is installed:

git clone https://github.com/NayJi7/gitoui
cd gitoui
cargo build --release
./target/release/gitoui

GitHub features

The Pull Requests and Issues views need:

A repo with a github.com remote (any of origin, upstream, or a custom name, gitoui scans git remote -v at startup).
A logged-in GitHub account via OAuth device-flow (configure under the Configuration page, section “GitHub Auth”). Token is stored at ~/.config/gitoui/github_token.toml with 0600 permissions.