mango-ai-git-report

AI-powered Git Weekly Report Generator
基于 Git Commit 和 Git Diff，使用 AI 自动生成专业开发周报。

✨ 介绍

mango-ai-git-report 是一个 AI 驱动的 Git 周报生成 CLI 工具。

它可以自动读取 Git 仓库中的：

• Git Commit 提交记录
• Git Diff 代码变更

并结合 AI 分析代码修改内容，生成结构化的开发周报。

适用于：

• 开发人员周报生成
• 多仓库工作总结
• 项目进度记录
• 技术团队工作汇报

🚀 安装

使用 npx（推荐）

无需安装：

npx mango-ai-git-report --repo frontend --days 7

全局安装

npm install -g mango-ai-git-report

安装后：

mango-ai-git-report --repo frontend --days 7

🔑 配置 AI Key

本工具使用 DeepSeek API 生成报告。

使用前需要配置环境变量：

Mac / Linux

export DEEPSEEK_API_KEY=your_deepseek_api_key

Windows

set DEEPSEEK_API_KEY=your_deepseek_api_key

检查是否配置成功：

echo $DEEPSEEK_API_KEY

📖 使用方式

基础使用

npx mango-ai-git-report --days 7
mango-ai-git-report --repo frontend --days 7

指定仓库

mango-ai-git-report \
--repo frontend \
--days 7

输出文件

mango-ai-git-report \
--repo frontend \
--days 7 \
--output report.md

指定输出格式

mango-ai-git-report \
--repo frontend \
--days 7 \
--format md

⚙️ 参数说明

| 参数 | 简写 | 说明 | 默认值 | | --- | --- | --- | --- | | --repo | -r | Git仓库名称 | 当前仓库 | | --days | -d | 获取最近提交数量 | 7 | | --output | -o | 输出文件路径 | - | | --format | -f | 输出格式 | md |

📝 输出示例

生成内容：

# 开发周报

## 一、功能开发

### Agent 文件操作能力扩展

- 新增 write_file 工具
- 支持 Agent 自动创建和修改文件
- 完善文件操作流程


## 二、功能优化

### Git 分析能力优化

- 支持多仓库路径解析
- 增加 Git 仓库合法性校验

✨ 功能特性

• ✅ 自动读取 Git Commit
• ✅ 自动解析 Git Diff
• ✅ AI 自动分析代码变化
• ✅ 支持多个 Git 仓库
• ✅ 支持 Agent Tool Calling
• ✅ 支持文件操作工具
• ✅ 支持 Markdown 周报输出
• ✅ TypeScript 开发

🏗️ 技术栈

• Node.js
• TypeScript
• Commander
• OpenAI SDK
• DeepSeek API
• Git CLI

🧠 工作流程

Git Repository

      |
      ↓

git log 获取提交记录

      |
      ↓

git diff 分析代码变化

      |
      ↓

组装 Prompt

      |
      ↓

AI 分析

      |
      ↓

生成开发周报

📂 项目结构

mango-ai-git-report

├── src
│   ├── agent
│   │   ├── runAgent.ts
│   │   └── toolMap.ts
│   │
│   ├── tools
│   │