vig User Guide

vig is a read-only TUI cockpit for a repository and everything working around it: git (side-by-side diffs, log, reflog), GitHub issues / pull requests / Actions runs / Projects boards, a file browser, Docker containers, running processes, and worktrees / stashes — with vim-style keybindings throughout. It is built for keeping an eye on busy repositories, including ones where AI agents do the work.

Safe by design — vig only performs read operations and safe git commands (git switch, git branch -d). Destructive operations like merge, rebase, force delete, or push are intentionally excluded. vig helps you inspect your repository, not mutate it.

What’s in this guide

• Getting Started — installation, your first run, a tour of the seven views, and what vig needs from your environment.
• Views — one chapter per view: what it shows, every key binding, and each view’s constraints.
• Configuration Basics — where config files live, the three layers (builtin → user → repo-local), the vig config subcommands, just enough KDL, and the merge rules.
• Config Recipes — worked, copy-pasteable examples: themes, keybindings, tabs, layouts, slots, board pinning, per-repository config, polling. Every example is CI-verified.
• Config Reference — the complete reference: every node with its form, default, merge rule and errors, and every page’s panes and actions.
• Troubleshooting / FAQ — config errors, gh authentication and scopes, rate limits, fonts, image previews, and where vig keeps its files.

日本語版

This guide is also available in Japanese: vig ユーザーガイド (in-repo: docs/guide/ja).