Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

vig ユーザーガイド

vig はリポジトリと、その周りで動いているものを見張るための閲覧専用 TUI コックピットです: git (サイドバイサイドの差分・ログ・reflog)、GitHub の issue / PR / Actions 実行 / Projects ボード、ファイルブラウザ、Docker コンテナ、プロセス、worktree / stash。全体を vim スタイルのキーで操作できます。AI エージェントが作業するリポジトリを含め、busy なリポジトリの監視を想定して作られています。

安全設計 — vig は読み取り操作と安全な git コマンド(git switchgit branch -d)のみを実行します。merge、rebase、force delete、push などの破壊的操作は意図的に除外しています。vig はリポジトリを 眺めるためのツールであり、変更するためのツールではありません。

このガイドの構成

  • Getting Started — インストール、最初の起動、 7 つのビューのツアー、必要な環境。
  • ビュー — ビューごとに 1 章: 何が表示されるか、 すべてのキーバインド、各ビューの制約。
  • 設定の基本 — 設定ファイルの場所、3 つの レイヤ(組み込み → ユーザー → リポジトリローカル)、vig config サブコマンド、最低限の KDL、マージ規則。
  • 設定レシピ — コピーしてそのまま使える実例集: テーマ、キーバインド、タブ、レイアウト、slot、ボードの固定、 リポジトリごとの設定、ポーリング。すべての例は CI で検証されています。
  • 設定リファレンス — 完全なリファレンス: すべてのノードの書式・デフォルト・マージ規則・エラーと、全ページの ペインとアクション。
  • トラブルシューティング / FAQ — 設定エラー、 gh の認証とスコープ、レート制限、フォント、画像プレビュー、vig が ファイルを置く場所。

English version

このガイドの英語版はこちら: vig User Guide (リポジトリ内: docs/guide)。