gitui

Fast terminal UI for Git written in Rust

TLDR

Start GitUI

$ gitui

Start in specific directory

$ gitui -d [path]

Use custom theme

$ gitui --theme [theme.ron]

Use a file-system watcher instead of polling

$ gitui --watcher

Generate a bug report

$ gitui --bugreport

gitui is a fast terminal UI for Git. It provides a keyboard-driven interface for staging, committing, branching, and viewing diffs, all within the terminal.Written in Rust, gitui is lightweight and responsive. It displays status, log, diff, and staging information in a split-pane interface with vim-like key bindings.

PARAMETERS

-d PATH, --directory PATH

Set the git directory (defaults to `.` or `$GIT_DIR`).

-w PATH, --workdir PATH

Set the working directory (defaults to the current directory or `$GITWORKTREE`).

-t FILE, --theme FILE

Set the color theme filename, loaded from the config directory (default: `theme.ron`).

-f FILE, --file FILE

Select a file in the file tab on startup.

-k FILE, --key-bindings FILE

Use a custom keybindings file.

-s FILE, --key-symbols FILE

Use a custom symbols file.

-l, --logging

Store logging output into a file in the cache directory.

--logfile FILE

Store logging output into the specified file (implies --logging).

--watcher

Use a notify-based file system watcher instead of the default tick-based polling.

--bugreport

Generate a bug report.

-h, --help

Display help information.

-V, --version

Display version information.

CONFIGURATION

~/.config/gitui/theme.ron

Theme configuration file in RON format for customizing colors and appearance.

~/.config/gitui/key_bindings.ron

Key binding customization file.

INSTALL

sudo dnf install gitui

sudo pacman -S gitui

sudo apk add gitui

sudo zypper install gitui

brew install gitui

nix profile install nixpkgs#gitui

CAVEATS

Terminal UI needs appropriate terminal. Some features limited compared to full GUI. Themes require RON format. By default, gitui polls the working directory for changes every few seconds; pass --watcher for faster, notify-based change detection on platforms where it works reliably.