git-weekly-report

基于 Git 提交记录 + DeepSeek AI 自动生成结构化技术周报。

还在每周五花半小时手写周报？让工具帮你搞定。

功能

• 自动解析 Git log，提取本周所有提交
• AI 智能分类：需求开发 / Bug修复 / 技术优化 / 文档
• DeepSeek 生成人类可读的周报摘要
• 支持 Markdown / HTML 双格式输出
• 多仓库汇总，一份周报覆盖所有项目
• 一键推送到钉钉 / 飞书 / 企业微信
• 规则分类兜底，无 API Key 也能用

快速开始

# 无需安装，直接使用
npx git-weekly-report --no-ai --repo /path/to/your/project

# 或者全局安装
npm install -g git-weekly-report
weekly-report --no-ai

使用示例

基础用法（规则分类，无需 API Key）

# 扫描当前仓库，最近 7 天
weekly-report --no-ai

# 指定仓库路径和时间范围
weekly-report --no-ai --repo /path/to/project --since 2026-04-21 --until 2026-04-28

# 输出到文件
weekly-report --no-ai --output weekly.md

AI 智能总结（DeepSeek）

# 设置 API Key
export DEEPSEEK_API_KEY=sk-xxx

# 生成 AI 增强周报
weekly-report --repo /path/to/project

多仓库汇总

weekly-report --no-ai \
  --repo /path/to/project-a \
  --repo /path/to/project-b \
  --output weekly.md

推送到钉钉/飞书/企业微信

# 设置 Webhook
export DINGTALK_WEBHOOK=https://oapi.dingtalk.com/robot/send?access_token=xxx

# 生成并推送
weekly-report --no-ai --push dingtalk

交互式配置

weekly-report init

生成 .weeklyrc.yml 配置文件，之后直接 weekly-report 即可。

配置文件

在项目根目录创建 .weeklyrc.yml：

repos:
  - /path/to/project-a
  - /path/to/project-b
author: "Your Name"
format: md
noAi: false

deepseek:
  baseURL: https://api.deepseek.com
  model: deepseek-chat

ignore:
  - "Merge pull request"
  - "Merge branch"
  - "chore: release"

命令行参数

| 参数 | 说明 | 默认值 | |---|---|---| | --since <date> | 起始日期 | 7天前 | | --until <date> | 结束日期 | 今天 | | --author <name> | Git 作者 | 当前用户 | | --repo <path> | 仓库路径（可多个） | 当前目录 | | --config <file> | 配置文件路径 | .weeklyrc.yml | | --output <file> | 输出文件 | stdout | | --format <type> | md / html | md | | --no-ai | 跳过 AI，规则分类 | false | | --push <target> | 推送目标 | - |

输出示例

# 技术周报 2026-04-22 ~ 2026-04-29

## 本周工作总结

### Bug 修复
- 修复分页查询在数据量超过 10 万条时的内存溢出问题 (3 files, +45/-12)
- 修复移动端列表页面样式错位 (2 files, +8/-4)

### 技术优化
- 优化数据库查询性能，将首页加载时间从 2.1s 降至 0.8s (5 files, +120/-80)

## 统计
| 指标 | 数值 |
|---|---|
| 总提交次数 | 41 |
| 涉及文件数 | 192 |
| 新增代码行 | +3097 |
| 删除代码行 | -3261 |

技术栈

TypeScript / Node.js / simple-git / DeepSeek API / EJS

License

MIT