Skip to content

Requirements

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

ToolVersionWhy
git2.30+gitoui shells out to the CLI for every git operation.
A terminalRecent (see below)The commit graph and avatars are rendered inline as images.
xdg-open / openplatform defaultUsed by the “open in browser” shortcut for PRs and issues.

gitoui pre-renders the commit graph as SVG/PNG and ships it inline. To see the graph, your terminal needs to speak one of:

Protocolrecommended when…Terminals (non-exhaustive)
Kittyavailable, auto-detect defaultGhostty (recommended), Kitty, WezTerm, Konsole 22.04+, modern gnome-terminal / Ptyxis (VTE ≥ 0.78)
iTerm2on macOSiTerm2, WezTerm
Sixelnothing else worksfoot (Wayland), mlterm, xterm -ti vt340, WezTerm
Unicodefallback in any other terminalAlacritty, 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.

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

ToolVersionNotes
Rust1.88+rust-toolchain.toml not pinned, use stable.
Cargoships with Rust
cc / cargo-compatible linkerplatform defaultFor native deps (sharp isn’t required, this is Rust only).

Once Rust is installed:

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

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.