分享一个生成 Git 提交记录周报的 CLI 工具 - weekly-git-summary
最近开发了一个 CLI 工具,专门用来生成 Git 提交记录的周报汇总,特别适合需要定期汇报工作进展的开发者。
主要功能
- 自动扫描 Git 仓库 - 支持多仓库扫描,最大深度 2 层
- 多种输出格式 - 支持彩色终端、JSON 、Markdown 、HTML 格式
- 灵活的时间范围 - 可以指定任意时间段,默认本周
- 跨平台支持 - Windows/macOS/Linux 都可用
- 零配置使用 - 开箱即用
使用场景
- 周报/月报生成
- 项目进展汇总
- 代码 review 准备
- 团队工作统计
快速开始
css
# 全局安装
npm install -g weekly-git-summary
# 或直接使用(推荐)
npx weekly-git-summary
# 常用命令
npx weekly-git-summary --dir ~/projects --since 2023-01-01 --until 2023-01-31
npx weekly-git-summary --author "张三" --md
npx weekly-git-summary --json
输出示例
yaml
工作内容 Git 提交记录汇总
统计时间范围: 2023-06-26 到 2023-07-02
搜索目录: .
📦 my-project (github.com/user/my-project)
📅 2023-07-02
• feat: 添加用户认证功能 (作者: 张三, hash: abc123)
• fix: 修复登录页面样式问题 (作者: 李四, hash: def456)
📅 2023-07-01
• docs: 更新 API 文档 (作者: 王五, hash: ghi789)
主要特性
- 智能仓库扫描 - 自动发现子目录中的 Git 仓库
- 多种输出格式 - 终端彩色输出、JSON 、Markdown 、HTML
- 作者过滤 - 可以只显示特定作者的提交
- 时间范围灵活 - 支持自定义开始和结束日期
- Web 可视化 - 还包含一个漂亮的 Web 界面
技术栈
- TypeScript + Node.js
- 跨平台架构(自动选择 Bash/PowerShell/Node.js 实现)
- 使用 Bun 构建
- 完整的测试覆盖
项目地址: www.npmjs.com/package/wee...
有类似需求的朋友可以试试,欢迎反馈和建议!