dirtygit

dirtygit

What does this do?

• Scans a whole bunch of directories looking for git repos
• Shows you only the ones that seem to be somehow dirty, i.e. one of:
  • It has uncommitted file
  • It has local branches that don't match remote branches

Why is this useful?

You're busy. You probably context-swapped a while back and forgot to commit/push a thing.

There's a whole bunch of tools that are very good at managing a single git repo, but I've not found many that look at the bigger picture. dirtygit helps you to know whether you care about the things that are only on your local system, so that you can ensure they get pushed to your git server.

Source-mode installation

go install github.com/boyvinall/dirtygit@latest

From a clone of this repository:

go install .

Configuration

Copy .dirtygit.yml to ~/.dirtygit.yml and edit to your needs. Environment variables in paths are expanded. Options include:

Opening a repo (edit.command)

edit.command is a YAML list of argv pieces passed to exec (no shell). Put the literal {repo} in any argument to substitute the absolute repository path. If no argument contains {repo}, the path is appended as the last argument. Environment variables in each argument are expanded. If edit.command is omitted or empty, the default is code with the repo path (VS Code on PATH).

Running

dirtygit [ <directories...> ]

If you pass one or more <directories>, they replace scandirs.include from your config for that run (paths are still expanded from the environment).

UI

The layout needs a terminal height of at least 22 rows and width of at least 20 columns. While a scan runs, a modal shows how many repositories were found, how many have been checked, and the path currently being processed.

Focus moves across five panes in order: Repositories, Status, Branches, Diff, and Log. Status and Branches share one row (side by side); Diff sits below them. The mouse is enabled: click a pane to focus it, or a row in Repositories / Status to move the selection. Drag a pane border to resize splits (unavailable when zoomed, scanning, on error, or with an overlay open). The Status table lists dirty files with Worktree and Staged columns (same left-to-right order as the Diff pane). The Diff pane runs git diff with basic colorization; use ← / → in Status or Diff to switch between Worktree and Staged views. With a file row selected, a runs git add and r runs git reset (unstage) on that path (from the Status or Diff pane), then the current repo is refreshed.

With Repositories focused, w opens a short explanation of why the current repo is listed, and D asks to recursively delete that directory on disk (with confirmation). Both are for housekeeping local clones you no longer need.

The Branches pane lists local branches that need attention: tips that do not match every configured remote, missing same-named remote refs, or branches listed under branches.default. Local-only branches can be hidden when they match branches.hidelocalonly.regex (unless they are defaults). The Remotes column compresses each remote into a short status (ok, missing, differs, or +N / -M style counts when histories are comparable).

Development

make lint
make test