Getting Started

Requirements

• Python 3.11+
• An interactive terminal (stdin and stdout must be TTYs)
• macOS / Linux for the full TUI; on Windows, CLI sub-commands are available

Installation

pip install -U pigit

From source:

git clone https://github.com/zlj-zz/pigit.git --depth=1
cd pigit
pip install -e .

Development install:

pip install -e ".[dev]"

First run

pigit

The TUI opens automatically when you run pigit with no sub-command.

Panel navigation, staging, and the command palette (recorded from the TUI).

Essential keys

Key	Action
1 / 2 / 3 / 4	Status / Stash / Branch / Commit
Tab	Cycle panels
;	Command palette
?	Key bindings for the focused panel
U	Undo last action
Q / Esc	Quit / back

Command palette

Press ;, type a command name, then space to complete branch or file arguments. Use Tab to fill the selected candidate into the input line.

The full binding list lives in the Keyboard Reference.

Shell integration

Generate completion scripts and the repo cd wrapper:

eval "$(pigit --init)"

Add that line to ~/.bashrc, ~/.zshrc, or your fish config. Supports bash, zsh, and fish.

Next steps

Topic	Page
Panel workflows and diff viewer	TUI Guide
; checkout, ; reflog, Tab completion	Command Palette
Daily commit flow, undo vs reflog	Workflows
Non-interactive commands	CLI
pigit.toml, key remapping	Configuration
TTY, icons, stale panels	Troubleshooting

Build the docs locally

pip install mkdocs-material
mkdocs serve --config-file docs/site/mkdocs.yml

Open the URL printed in the terminal (usually http://127.0.0.1:8000).