pi-git-tui
v0.2.0
Published
Interactive Git diff, staging, history, and commit TUI for Pi.
Maintainers
Readme
Pi Git TUI
A GitHub Desktop-style diff, staging, history, and commit workflow inside Pi.
Review syntax-highlighted changes, move files between the working tree and index, browse commits, manage branches, tags, and stashes, and commit without leaving Pi.
Why This Exists
Pi is already where the code changes happen. Reviewing those changes should not require switching to another app or reconstructing the state of the index from terminal commands.
pi-git-tui adds one full-screen /diff view with:
- a file tree and responsive diff viewport;
- separate, index-exact working and staged views;
- syntax highlighting with GitHub Desktop-style intraline changes;
- commit history, branch, tag, stash, and worktree pickers;
- guarded Git commands and recoverable async operations.
Normal Git operations stay local. The model is only involved when you explicitly ask Pi to generate a commit message.
Install
Install the packaged extension from npm:
pi install npm:pi-git-tuiOr directly from GitHub:
pi install git:github.com/NikolaiUgelvik/pi-git-tuiRestart Pi after installation.
Quick Start
Open the viewer from any directory inside a Git repository:
/diffThe viewer opens on working-tree changes. Press ? or F1 at any time for context-sensitive help.
Everyday Workflow
| Key | What it does | |-----|--------------| | Tab | Switch between the file tree and diff | | ↑/↓ or j/k | Move through files or scroll the diff | | n/p | Select the next or previous file | | v | Toggle working and staged views | | Enter | Stage the selected working file or unstage the selected staged file | | Shift+Enter | Stage all remaining changes or unstage everything | | C | Review staged changes; press again to open the commit dialog | | c | Browse the working tree and recent commits | | t | Browse tags or create one at a selected commit | | Ctrl+P | Open the Git command menu | | r | Reload the active diff or retry a failed refresh | | Shift+S | Open Pi Git TUI settings | | ? / F1 | Open context-sensitive help | | q / Esc | Close the viewer or active overlay |
The diff viewport also supports half-page scrolling and fixed line-number gutters. Long lines wrap by default; when wrapping is disabled, use ←/→ to scroll horizontally and Shift+←/→ for larger jumps.
Settings
Press Shift+S inside /diff to open the settings overlay. Use Enter or Space to change a value, Ctrl+S to save, or Esc to discard the draft.
Settings are global and stored in pi-git-tui.json inside Pi's agent directory—normally ~/.pi/agent/pi-git-tui.json, or the directory selected by PI_CODING_AGENT_DIR:
{
"diff": {
"wrap": true
}
}Staging and Committing
The working and staged views come directly from Git. pi-git-tui does not approximate one from the other, so partially staged and mixed files remain accurate.
A typical commit flow:
- Select a file and press Enter to stage its remaining changes.
- Press v to inspect the exact staged diff.
- Press C to enter staged review, then C again to compose the commit.
- Type a message, or press Ctrl+G to generate one from the staged diff.
- Press Enter to commit.
Inside the commit dialog, Ctrl+X toggles amend mode. Normal commits are blocked when the index is empty; amend remains available when the repository has an existing HEAD.
History and Repository Tools
Commit history
Press c to search recent commits by hash or message. Select a commit to inspect its diff, then press W to return directly to the working tree.
Branches, tags, worktrees, and stashes
| Key | Tool | |-----|------| | b | Search and switch branches; Ctrl+N creates one | | t | Search tags and inspect their commits; Ctrl+N starts annotated or lightweight tag creation | | w | Search and switch worktrees | | s | Create, apply, pop, or drop stashes | | D | Review and confirm discarding the selected working-tree file | | I | Initialize Git when the current directory is not a repository |
Git command menu
Press Ctrl+P to search and run common commands:
- fetch, fetch with prune, or fetch all remotes;
- pull, fast-forward-only pull, or pull with rebase;
- push, push tags, or force-push with lease;
- initialize and update submodules.
Force-push always performs a porcelain dry run, shows the resolved destination and ref updates, and requires a second confirmation before execution.
Diff Rendering
- Syntax highlighting is resolved from each file path, including renamed files.
- Added and deleted blocks use subtle theme backgrounds while intraline changes use a stronger shade.
- Intraline highlighting follows GitHub Desktop's behavior: equal-sized change blocks are paired by position, then the common prefix and suffix are removed to reveal one changed range.
- Long content wraps at whitespace when possible, falling back to hard wrapping only for overlong tokens; continuation rows use a blank gutter.
- Tabs, combining characters, CJK text, emoji, and wide graphemes remain safe during wrapping and horizontal slicing.
- Unsupported, binary, malformed, and oversized inputs fall back to a bounded plain presentation.
- Narrow terminals switch to a single focused panel instead of squeezing both panes together.
Safety
Git state can change while a command is running, so the viewer treats every load and mutation as an explicit operation:
- destructive actions require confirmation;
- Escape cancels active observation and triggers reconciliation when a mutation may already have taken effect;
- failed post-mutation refreshes retry the refresh only—the Git mutation is never run twice;
- stale async results cannot overwrite a newer repository, worktree, or document;
- large files and diffs stay visible as
(omitted)entries with the measured limit and reason instead of being truncated mid-hunk; - Git commands use bounded local, mutation, and network timeouts.
How It Works
/diffcaptures one strict porcelain-v2 repository snapshot.- Staged and working patches are loaded as separate bounded slices.
- Parsed files become immutable presentation rows with syntax and intraline styling.
- Tree, presentation, and filtered-list caches keep navigation and scrolling responsive.
- A single operation coordinator serializes loads, mutations, cancellation, reconciliation, and refresh-only recovery.
See docs/architecture.md for the full state model, Git boundaries, rendering pipeline, and testing strategy.
Development
Run the extension directly from source:
npm install
npm run devUseful development commands:
# Persistent type checking
npm run typecheck:watch
# One test file or the full suite in watch mode
npm run test:file -- tests/diff-intraline.test.ts
npm run test:watch
# Full repository checks
npm test
npm run check
# Verify the package and source extension
npm run smoke:packagePi loads extensions/diff.ts through its built-in jiti loader. npm and Git installs use the TypeScript source directly, so no production build is required.
Performance fixtures are available through benchmark:git, benchmark:render, benchmark:load, and benchmark:loop.
Release
Publishing is triggered by publishing a GitHub release whose tag matches the
version in package.json (for example, v0.1.0). The repository must be
configured as a trusted publisher for pi-git-tui on npmjs.com.
License
Copyright 2026 Nikolai Ugelvik.
This project is licensed under the Apache License, Version 2.0.
Limitations
- Staging operates on the selected file's remaining changes or the full active slice; interactive hunk/line staging is not currently exposed.
- Historical diffs are read-only. Return to the working tree before running mutations.
- Very large inputs are intentionally represented as explicit omissions rather than partially rendered patches.
