peekgit

PeekGit

终端里的多仓库监控面板。一次性查看 workspace 下所有 Git 仓库的分支状态、同步情况，以及 GitHub PR / Issues。

环境要求 (Environment Requirements)

• Git: 最低要求 2.7.0 (推荐 2.13.0+)，用于解析本地仓库状态和远程 URL。
• GitHub CLI (gh): 最低要求 2.0.0 (推荐 最新版)，用于通过 gh auth token 自动获取认证信息。
• Go: 1.21+ (仅限从源码构建)。

安装

Homebrew (推荐 - macOS/Linux)

brew tap Fairfarren/peekgit https://github.com/Fairfarren/peekgit
brew install Fairfarren/peekgit/peekgit

Scoop (推荐 - Windows)

# 需要先安装 Scoop: https://scoop.sh/
scoop install https://raw.githubusercontent.com/Fairfarren/peekgit/master/scoop/peekgit.json

说明：当前发布提供 Windows x64（peekgit_windows_x86_64.zip）产物。

手动安装 (Windows 备用)

1. 从 GitHub Releases 下载 peekgit_windows_x86_64.zip
2. 解压后将 peekgit.exe 所在目录加入 PATH

Go install

go install github.com/Fairfarren/peekgit/cmd/peekgit@latest

本地构建

git clone https://github.com/Fairfarren/peekgit.git
cd peekgit
go build -o peekgit ./cmd/peekgit

外部依赖 (Lazygit)

PeekGit 集成了 Lazygit 终端 UI，用于在仓库详情中通过快捷键 g 快速打开。

由于 Lazygit 是一个独立的二进制文件，你需要根据其 官方安装文档 手动下载并安装到你的 PATH 中。

快速开始

配置好 ~/.config/peekgit/config.json 后，在任意目录直接运行：

peekgit

程序启动后会先进入启动页，包含三个标签：workspace、pr、issues。

• workspace：展示工作区卡片，选中后按 Enter 进入多仓库监控面板。
• pr：展示当前 GitHub 账号创建的 PR 列表。
• issues：展示当前 GitHub 账号创建或 assignee 为自己的 Issues 列表。

命令行参数

peekgit --interval 60 --concurrency 5
peekgit --workspaces
peekgit --workspaces=2

全局配置文件

PeekGit 使用全局配置文件 ~/.config/peekgit/config.json 来定义你的工作区和对应监控的 Git 仓库路径。

你可以将常用的项目分门别类配置在里面（支持 ~ 展开到用户目录）：

{
  "workspaces": {
    "Fairfarren": [
      "~/work/www/peekgit",
      "~/open-source/awesome-project"
    ],
    "My Work": [
      "~/company/frontend",
      "~/company/backend-api"
    ],
    "All Projects": [
      "~/projects/*"
    ]
  }
}

通配符路径：

如果路径以 /* 结尾，程序会自动扫描该目录下的所有子目录，并找出其中的 Git 仓库。这样你就不需要一个一个地添加路径了：

{
  "workspaces": {
    "All My Projects": [
      "~/projects/*"
    ]
  }
}

上面的配置会自动把 ~/projects/ 目录下的所有 Git 仓库都加入监控。 行为规则：

• 程序启动时默认进入 workspace 标签，并展示你在 json 中配置的全部 Workspaces 卡片列表。
• 选择某个 Workspace 后，加载该 Workspace 中定义的所有仓库。
• 程序运行中会持续监听配置文件变动（约每 2 秒检查一次），变更后自动热刷新 Workspaces 与仓库列表。

GitHub 集成

程序会自动尝试获取 GitHub Token，用于显示 PR 和 Issues 信息。支持以下方式（按优先级）：

1. 环境变量 GITHUB_TOKEN
2. gh auth token（GitHub CLI）

未认证时程序正常运行，只是不显示 PR / Issues 数据。

键盘操作

启动页 (workspace / pr / issues)

仓库列表视图 (Home)

详情页

Diff 查看

分栏布局（3:7比例）：左侧树形展示修改文件列表，右侧显示选中文件的 diff 内容。

状态图标

仓库状态（详情页）

Workspace 卡片状态

致谢 (Credits)

特别感谢 Lazygit 项目，它为 PeekGit 提供了出色的终端 Git 管理体验。

开源协作

• 许可证：见 LICENSE
• 贡献方式：见 CONTRIBUTING.md
• 行为准则：见 CODE_OF_CONDUCT.md
• 安全策略：见 SECURITY.md
• 变更记录：见 CHANGELOG.md

项目结构

cmd/peekgit/           CLI 入口
internal/
  config/              命令行参数解析与 config.json 解析
  workspace/           仓库有效性验证与绝对路径扫描
  gitcli/              本地 Git 操作
  provider/github/     GitHub API 集成与缓存
  model/               共享数据模型
  tui/                 终端界面
  cache/               TTL 缓存