https://github.com/jimyag/commitlens

Merged PR and per-contributor stats for GitHub repos: terminal TUI + embedded web UI. Parses Co-authored-by (noreply) for shared credit.
https://github.com/jimyag/commitlens

github golang react

Last synced: about 1 month ago
JSON representation

Merged PR and per-contributor stats for GitHub repos: terminal TUI + embedded web UI. Parses Co-authored-by (noreply) for shared credit.

• Host: GitHub
• URL: https://github.com/jimyag/commitlens
• Owner: jimyag
• Created: 2026-04-23T15:38:20.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2026-05-08T04:25:38.000Z (about 2 months ago)
• Last Synced: 2026-05-08T06:27:56.519Z (about 2 months ago)
• Topics: github, golang, react
• Language: Go
• Size: 14.6 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README-zh.md

Awesome Lists containing this project

README

          
# CommitLens

一个通用的 Git 贡献分析工具，深度追踪每位贡献者的**提交数**、**新增行数**与**删除行数**。它拥有强大的本地 Git 分析引擎、极速的终端 TUI 界面，以及嵌入在单一二进制文件中的现代化 Web UI。

![TUI 概览](docs/screenshots/tui-contributors.png)

## 核心功能

- **通用 Git 引擎**：同时支持本地文件系统仓库和远程 GitHub 仓库 URL（通过自动 Bare Clone）。分析历史记录无需担心 GitHub API 速率限制。

- **高级过滤查询**：支持仓库和贡献者的**多选**过滤。可按周、月、季度或年进行下钻分析。

- **贡献趋势分析**：

  - **提交量趋势**：直观展示历史活跃度。

  - **代码行数趋势**：通过堆叠柱状图追踪代码产出与重构力度（新增/删除行）。

- **交互式 TUI**：由 `bubbletea` 驱动的极速、全键盘操作终端界面。

- **现代化 Web UI**：基于 React + ECharts 的响应式界面，支持搜索、滚动和高密度数据展示。

- **多作者识别**：基于 `Co-authored-by` 准确计算所有贡献者的功劳。

- **单二进制部署**：前端资源编译进二进制文件，一个文件即开即用。

- **生产级 CI/CD**：集成 GitHub Actions 与 GoReleaser，实现多平台自动构建发布。

## 界面截图

### 终端 TUI

| 提交趋势 | 提交历史 |

| :---: | :---: |

| ![TUI Trend](docs/screenshots/tui-trend.png) | ![TUI Commits](docs/screenshots/tui-commits.png) |

### Web 界面

| 仪表盘 (提交) | 行数趋势 | 提交历史 |

| :---: | :---: | :---: |

| ![Web Commit Trend](docs/screenshots/web-trend-commits.png) | ![Web Lines Trend](docs/screenshots/web-trend-lines.png) | ![Web Commits](docs/screenshots/web-commits.png) |

## 快速开始

### 安装

从 [Releases](https://github.com/jimyag/commitlens/releases) 下载最新版本的二进制文件。

### 配置

创建一个 `config.yaml`：

```yaml

discoveryRoots:

  - ~/src/github.com/kubernetes  # 自动扫描此目录下所有 git 仓库

repositories:

  - url: https://github.com/kubeovn/kube-ovn.git # 远程仓库

userMap:

  "Jim Yang": ["jimyag", "yang.jim@example.com"] # 将多个别名映射到同一个自然人

```

### 使用

```bash

# 启动终端 TUI

./commitlens --config config.yaml

# 启动 Web UI (默认端口: 8080)

./commitlens --web --config config.yaml

```

## 快捷键 (TUI)

- `1-5`: 切换标签页 (汇总, 仓库, 提交趋势, 行数趋势, 提交列表)。

- `[` / `]`: 轮换标签页。

- `Tab`: 在过滤器与内容区之间切换焦点。

- `Enter`: 展开过滤器下拉框 / 查看提交详情。

- `Space`: 在下拉列表中进行多选。

- `Shift + ←/→`: 左右横移缩放趋势图。

- `R`: 强制同步/刷新数据。

- `Q`: 退出。

## 开发

### 依赖

- Go 1.22+

- Node.js 20+ & npm

### 从源码编译

```bash

make build

```

## 许可证

MIT