revui

README

revui

Understand a branch before it becomes a pull request.

revui is a fast, local review workspace for Git branches. It keeps the changed-file tree on the left and a GitHub-like, syntax-highlighted diff on the right, then lets you inspect complete files, search the repository, track reviewed files, and copy precise code context into any editor or LLM.

revui never connects to GitHub or sends code anywhere. It does not edit files, commit, push, or invoke an agent.

Install

Download a macOS or Linux archive from GitHub Releases, extract it, and place revui on your PATH.

With Go 1.25 or newer:

go install github.com/TenaciousMaker/revui/cmd/revui@latest

Build from source:

git clone https://github.com/TenaciousMaker/revui.git
cd revui
make build
./revui --version

Five-minute workflow

Run revui anywhere inside a Git repository:

revui

revui detects the repository's default branch and reviews everything since its merge base, including committed, staged, unstaged, renamed, deleted, binary, and untracked changes. Override the comparison when needed:

revui --base origin/develop

1. Move through changed files with j/k or the mouse.
2. Press t for the directory tree and A for changed, context, or all files.
3. Press o to switch between the diff and complete source.
4. Press f to search text across the repository.
5. Press space when a changed file is reviewed.
6. Press y to copy the current line or a selected range with its file and source location.

The watcher refreshes the review after save bursts without moving your current file or line.

What makes it useful

• One coherent branch view. Merge-base comparison plus committed and working-tree changes.
• Review in context. Toggle changed files, their sibling context, or the entire non-ignored repository tree.
• Diff or source. Switch between unified/split diffs and the complete working or base file.
• Repository search. See grouped context around literal matches and jump directly to a source line.
• Durable progress. Reviewed files stay reviewed until their diff fingerprint changes.
• Location-rich copy. Keyboard ranges and pane-constrained mouse selections copy clean code with branch/base line locations.
• Fast navigation. Cached rendering, compact directory chains, and accelerated, frame-coalesced scrolling remain responsive in large repositories.
• Local by design. No account, token, network request, or working-tree mutation.

Keys

Key	Action
j / k, arrows	Move through files or code lines
Mouse click / wheel	Position the active row or scroll the pane under the pointer
Mouse drag	Select visible code inside the current pane
tab, h / l	Switch panes or navigate tree folders
t	Toggle flat and tree file layouts
A	Cycle changed, context, and all-files scopes
space	Toggle reviewed state for the selected changed file
w	Fit or restore the file-pane width
enter	Open a file, result, or folder
/	Fuzzy-jump to a changed file
f	Search text across the repository
o	Toggle complete source and diff
v, then move	Define a code range
y	Copy the current line or selected range with location
[ / ]	Jump to the previous or next hunk
s	Toggle unified and split diff
R	Refresh from Git
?	Show the complete keymap
q	Quit

Search inputs support arrows, Home/End, ctrl+a/e, ctrl+b/f, ctrl+u/k, ctrl+w, Backspace/Delete, and bracketed paste. Up/down continue to navigate results.

Copying code

y writes through the terminal's OSC52 clipboard protocol, which works in modern terminals locally and across SSH. The copied block contains the repository-relative file, branch or base line range, and plain source text—never rendered line numbers or diff markers.

If clipboard integration is disabled by your terminal or multiplexer, use its normal text-selection copy command. See Troubleshooting.

Files, state, and privacy

Global display preferences use the operating system's user configuration directory:

• macOS: ~/Library/Application Support/revui/preferences.json
• Linux: ${XDG_CONFIG_HOME:-~/.config}/revui/preferences.json

Flat/tree layout, file scope, pane width, and unified/split mode follow you across repositories. Cursor positions and expanded folders are temporary.

Reviewed-file fingerprints live under the repository's Git metadata at .git/revui. revui adds nothing to the working tree and makes no network requests. Repository search uses git grep and respects Git ignore rules.

Set NO_COLOR to disable semantic colors. Added/deleted markers and focus labels remain visible without color.

Supported environments

The v0.1 beta supports macOS and Linux on amd64 and arm64. revui needs Git and an interactive terminal with ANSI support. Mouse input and OSC52 clipboard behavior depend on the terminal; the full keyboard workflow remains available without either.

Troubleshooting

The wrong base was selected. Run revui --base <revision>. By default revui tries origin/HEAD, main, and master, then falls back to HEAD^.

Clipboard status says copied, but nothing appears. Enable OSC52 in the terminal or multiplexer, or use terminal-native selection copy.

Changes are not refreshing. Press R. Some networked or virtual filesystems do not emit reliable filesystem events.

Colors are difficult to distinguish. Set NO_COLOR=1; +, -, hunk headers, selected rows, and pane labels provide non-color cues.

The terminal is narrow. revui switches to a single visible pane. Use tab, h, or l to move between files and code.

Please use the bug report form for reproducible problems.

Development

make check          # formatting, vet, and tests
make test-race      # race detector
make coverage       # enforce the project coverage floor
make release-snapshot

See CONTRIBUTING.md and the architecture guide. The demo is reproducible with VHS: make demo.

Scope

revui is intentionally a pre-PR tool. It does not authenticate with GitHub, import or submit reviews, invoke an LLM, manage comments, create commits, push branches, or manage terminal sessions. Copy context out; bring conclusions back to your normal development workflow.

License

MIT