g2log 1.3.0

package/.git-user-log-config.json.example

@@ -0,0 +1,15 @@
+{
+  "api_key": "your-api-key-here",
+  "default_author": "张三",
+  "default_since": "yesterday",
+  "default_until": "today",
+  "model": "deepseek-chat",
+  "api_base_url": "https://api.deepseek.com",
+  "api_provider": "deepseek",
+  "repositories": {
+    "前端项目": "/path/to/frontend-project",
+    "后端项目": "/path/to/backend-project",
+    "移动端": "/path/to/mobile-app"
+  },
+  "prompt_template": "请根据下面的Git提交记录，用3-5句话简洁地总结一天的工作内容。\n\n以下是Git提交记录:\n\n{log_content}\n\n要求：\n1. 按项目和日期组织内容\n2. 每个项目每天的工作内容用3-5句话概括\n3. 使用清晰、专业但不晦涩的语言\n4. 突出重要的功能开发、问题修复和优化改进\n5. 适合放入工作日报的简洁描述\n6. 输出格式为：【日期】：\n                  【项目名称1】-【工作内容概述】\n                  【项目名称2】-【工作内容概述】\n7. 回复不要出现多余的内容，非必要不要用markdown格式"
+} 

package/CONFIG.md

@@ -0,0 +1,155 @@
+# Git用户日志工具配置说明
+
+Git用户日志工具支持通过配置文件来简化命令行参数输入，提高使用效率。配置文件默认保存在用户主目录下的 `.git-user-log-config.json`。
+
+## 配置文件结构
+
+配置文件采用JSON格式，包含以下主要配置项：
+
+```json
+{
+  "deepseek_api_key": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+  "default_author": "张三",
+  "default_since": "yesterday",
+  "default_until": "today",
+  "repositories": {
+    "前端": "/path/to/frontend-project",
+    "后端": "/path/to/backend-project"
+  },
+  "prompt_template": "请根据下面的Git提交记录，用3-5句话简洁地总结一天的工作内容。\n\n这些是{author}在{since}至{until}期间的Git提交记录:\n\n{log_content}\n\n..."
+}
+```
+
+## 配置项说明
+
+### API密钥设置
+
+```json
+"deepseek_api_key": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+```
+
+- 用于AI总结功能
+- 从DeepSeek官网获取API密钥后填入
+- 也可通过命令行设置：`git-user-log --set-api-key="YOUR_API_KEY"`
+
+### 默认作者
+
+```json
+"default_author": "张三"
+```
+
+- 设置默认的Git提交作者名称
+- 如果命令行不指定`--author`参数，将使用此默认值
+- 也可通过命令行设置：`git-user-log --set-default-author="张三"`
+
+### 默认时间范围
+
+```json
+"default_since": "yesterday",
+"default_until": "today"
+```
+
+- 设置查询Git提交记录的默认时间范围
+- 支持Git支持的各种时间格式：
+  - 具体日期：`2023-01-01`
+  - 相对日期：`1 week ago`, `yesterday`
+  - 特殊关键词：`today`, `last Monday`
+- 也可通过命令行设置：`git-user-log --set-time-range --since="yesterday" --until="today"`
+
+### 仓库配置
+
+```json
+"repositories": {
+  "前端": "/Users/username/Projects/frontend-project",
+  "后端": "/Users/username/Projects/backend-project",
+  "移动端": "/Users/username/Projects/mobile-app"
+}
+```
+
+- 设置仓库路径别名，方便快速切换不同项目
+- 键值对格式：`"别名": "完整路径"`
+- 自动处理功能：当配置了多个仓库时，不指定`--repo`参数会自动处理所有仓库并汇总结果
+- 使用方法：
+  - 处理所有仓库：`git-user-log --ai-summary`
+  - 指定单个仓库：`git-user-log --repo="前端" --ai-summary`
+- 管理命令：
+  - 添加仓库：`git-user-log --add-repo="前端" --path="/path/to/frontend"`
+  - 删除仓库：`git-user-log --remove-repo="前端"`
+  - 查看所有：`git-user-log --list-repos"`
+
+### AI提示词模板
+
+```json
+"prompt_template": "请根据下面的Git提交记录，用3-5句话简洁地总结一天的工作内容。\n\n这些是{author}在{since}至{until}期间的Git提交记录:\n\n{log_content}\n\n..."
+```
+
+- 自定义AI总结功能的提示词模板
+- 支持的变量：
+  - `{author}`: 提交作者
+  - `{since}`: 起始日期
+  - `{until}`: 结束日期
+  - `{log_content}`: Git提交日志内容
+- 设置方式：
+  - 通过配置文件直接设置
+  - 通过命令行从文件读取：`git-user-log --set-prompt-template="my-prompt.txt"`
+
+## 配置优先级
+
+1. 命令行参数具有最高优先级
+2. 配置文件中的设置作为默认值
+3. 如果都未指定，则部分参数会使用程序内置默认值
+
+## 多仓库自动处理功能
+
+当配置文件中设置了多个仓库，且运行命令时不指定`--repo`参数时，工具会：
+
+1. 自动获取所有配置仓库的Git提交记录
+2. 合并所有仓库的日志，并在每条记录前加上仓库标识
+3. 如果使用`--ai-summary`，将所有仓库的日志一起发送给AI进行总结
+4. 生成包含所有项目工作内容的统一总结
+
+这个功能特别适合：
+- 同时负责多个项目的开发人员
+- 需要生成包含所有项目的每日工作总结
+- 希望减少重复操作的场景
+
+## 配置示例
+
+### 基础配置示例
+
+```json
+{
+  "deepseek_api_key": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+  "default_author": "张三",
+  "default_since": "today",
+  "default_until": "today"
+}
+```
+
+### 带多个仓库的完整配置
+
+```json
+{
+  "deepseek_api_key": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+  "default_author": "张三",
+  "default_since": "yesterday",
+  "default_until": "today",
+  "repositories": {
+    "前端": "/Users/username/Projects/frontend-project",
+    "后端": "/Users/username/Projects/backend-project",
+    "移动端": "/Users/username/Projects/mobile-app",
+    "文档": "/Users/username/Projects/documentation",
+    "工具": "/Users/username/Projects/tools"
+  },
+  "prompt_template": "请根据下面的Git提交记录，用3-5句话简洁地总结一天的工作内容。\n\n这些是{author}在{since}至{until}期间的Git提交记录:\n\n{log_content}\n\n要求：\n1. 按项目和日期组织内容\n2. 每个项目每天的工作内容用3-5句话概括\n3. 使用清晰、专业但不晦涩的语言"
+}
+```
+
+## 使用技巧
+
+1. 设置适合自己的默认作者和时间范围，可以直接使用`git-user-log --ai-summary`生成今日工作总结
+2. 为经常使用的项目配置别名，避免每次输入完整路径
+3. 可以按团队、项目类型等方式组织仓库别名，便于管理
+4. 自定义AI提示词模板，使生成的工作总结更符合自己的风格和需求
+5. 对于跨多个仓库工作的开发者，利用多仓库自动处理功能大幅提高效率
+6. 建议保持API密钥的安全，不要将含有真实API密钥的配置文件提交到公共代码仓库 

package/PUBLISH.md

@@ -0,0 +1,111 @@
+# Git用户日志工具发布指南
+
+本文档提供了将Git用户日志工具发布到npm的步骤。
+
+## 准备工作
+
+1. 确保你有一个npm账号，如果没有，请在[npmjs.com](https://www.npmjs.com)注册
+
+2. 登录到npm：
+   ```bash
+   npm login
+   ```
+
+3. 更新package.json中的以下字段：
+   - `version`: 每次发布前增加版本号
+   - `author`: 填写你的名字和邮箱
+   - `repository.url`: 更新为你的GitHub仓库地址
+   - `bugs.url`: 更新为你的GitHub仓库issues地址
+   - `homepage`: 更新为你的GitHub仓库主页
+
+## 发布步骤
+
+1. 确保所有代码变更已提交并推送到GitHub
+
+2. 确保所有文件都有正确的执行权限：
+   ```bash
+   chmod +x git-user-log.js
+   chmod +x install.js
+   ```
+
+3. 检查是否所有必要的文件都会被包含在发布中：
+   ```bash
+   npm pack
+   ```
+   这将创建一个tar包而不实际发布。检查生成的.tgz文件内容，确保包含所有必要的文件，并且没有不需要的文件。
+
+4. 选择版本更新类型并发布：
+   ```bash
+   # 补丁版本更新 (修复bug等小变更)
+   npm version patch
+
+   # 次要版本更新 (添加新功能，但向后兼容)
+   npm version minor
+
+   # 主要版本更新 (重大变更，可能不向后兼容)
+   npm version major
+   ```
+
+5. 发布到npm：
+   ```bash
+   npm publish
+   ```
+
+   发布成功后，用户可以通过以下方式使用：
+   - 全局安装: `npm install -g g2log`
+   - 直接运行: `npx g2log [选项]`
+
+6. 发布成功后，为该版本创建一个GitHub release：
+   ```bash
+   git push --tags
+   ```
+   然后在GitHub上创建对应的release。
+
+## 更新已发布的包
+
+1. 进行代码修改
+
+2. 更新版本号：
+   ```bash
+   npm version patch  # 或minor或major
+   ```
+
+3. 再次发布：
+   ```bash
+   npm publish
+   ```
+
+## 撤回发布
+
+如果发现发布的版本有严重问题，可以在发布后24小时内撤回：
+
+```bash
+npm unpublish g2log@x.y.z  # 替换x.y.z为要撤回的版本号
+```
+
+## 本地测试
+
+在正式发布前，可以使用以下命令进行本地测试：
+
+```bash
+# 在本地创建全局链接
+./local-install.sh
+
+# 测试命令
+g2log --help
+
+# 完成测试后，移除本地链接
+npm unlink g2log
+```
+
+## NPX测试
+
+发布前测试npx调用：
+
+```bash
+# 先打包但不发布
+npm pack
+
+# 使用本地包进行测试
+npx -p ./g2log-x.y.z.tgz g2log --help
+``` 

package/README.md

@@ -0,0 +1,201 @@
+# Git 用户日志工具
+
+这是一个基于 Node.js 开发的命令行工具，用于获取指定用户在特定时间范围内的 Git 提交记录，并通过 AI 自动生成工作总结。
+
+## 功能特点
+
+- 🔍 自动从配置文件读取用户信息和仓库路径
+- 📅 支持灵活的时间范围过滤
+- 🎨 彩色命令行输出提升可读性
+- 📁 支持将结果导出到文件
+- 🔄 进度显示和友好的用户界面
+- 🤖 自动生成3-5句话的工作总结
+- ⚙️ 支持配置文件设置默认参数和多仓库别名
+- 🌊 支持流式输出AI响应，实时查看生成过程
+- 🔌 支持多种AI提供商API(OpenAI, DeepSeek)
+- 🚀 支持通过npx直接运行，无需安装
+
+## 安装与使用
+
+### 通过 NPX 直接运行（无需安装）
+
+```bash
+npx g2log [选项]
+```
+
+### 全局安装（推荐长期使用）
+
+```bash
+npm install -g g2log
+```
+
+然后使用:
+
+```bash
+g2log [选项]
+```
+
+或者：
+
+```bash
+# 从本地目录全局安装
+git clone https://github.com/yourusername/git-user-log.git
+cd git-user-log
+npm install -g
+```
+
+### 临时使用
+
+无需安装，直接使用 Node.js 运行脚本：
+
+```bash
+node git-user-log.js
+```
+
+## 使用方法
+
+```bash
+g2log [--since="2023-01-01"] [--until="2023-12-31"] [选项]
+```
+
+或通过npx直接运行:
+
+```bash
+npx g2log [--since="2023-01-01"] [--until="2023-12-31"] [选项]
+```
+
+### 命令行参数
+
+- `--since="YYYY-MM-DD"` - 起始日期（如未指定，使用配置中的默认值）
+- `--until="YYYY-MM-DD"` - 结束日期（如未指定，使用配置中的默认值）
+- `--local` - 使用本地仓库，忽略配置文件中的仓库设置
+- `--output="文件路径"` - 将输出保存到指定文件
+
+### 配置管理命令
+
+- `--set-api-key="KEY"` - 设置API密钥
+- `--set-ai-model="MODEL"` - 设置AI模型（默认: deepseek-chat）
+- `--set-api-provider="PROVIDER"` - 设置API提供商（deepseek或openai）
+- `--set-api-url="URL"` - 设置API基础URL
+- `--set-default-author="NAME"` - 设置默认作者
+- `--set-time-range --since="DATE" --until="DATE"` - 设置默认时间范围
+- `--add-repo="ALIAS" --path="/path/to/repo"` - 添加仓库配置
+- `--remove-repo="ALIAS"` - 删除仓库配置
+- `--list-repos` - 列出所有配置的仓库
+- `--set-prompt-template="file.txt"` - 从文件设置AI总结的prompt模板
+- `--reset-prompt-template` - 重置AI总结的prompt模板为默认值
+- `--fix-config` - 修复配置文件格式问题
+- `--help` - 显示帮助信息
+
+### 配置文件
+
+配置文件保存在用户主目录下的 `.git-user-log-config.json`，包含以下内容：
+
+```json
+{
+  "api_key": "your-api-key-here",
+  "default_author": "张三",
+  "default_since": "today",
+  "default_until": "today",
+  "model": "deepseek-chat",
+  "api_base_url": "https://api.deepseek.com",
+  "api_provider": "deepseek",
+  "repositories": {
+    "前端": "/path/to/frontend-project",
+    "后端": "/path/to/backend-project"
+  },
+  "prompt_template": "请根据下面的Git提交记录，用3-5句话简洁地总结一天的工作内容..."
+}
+```
+
+## 配置优先级
+
+1. 命令行参数优先级最高（仅支持时间范围参数）
+2. 配置文件中的设置作为默认值
+3. 内置默认值作为最低优先级
+
+## 示例
+
+```bash
+# 使用配置的默认值生成今日工作总结
+g2log
+
+# 指定时间范围
+g2log --since="2023-01-01" --until="2023-12-31"
+
+# 使用本地仓库
+g2log --local
+
+# 保存结果到文件
+g2log --output="today-summary.md"
+
+# 设置配置
+g2log --set-default-author="张三"
+g2log --set-ai-model="gpt-3.5-turbo"
+g2log --set-api-provider="openai"
+g2log --set-api-url="https://api.openai.com"
+g2log --add-repo="前端" --path="/path/to/frontend-project"
+```
+
+## 日期格式
+
+支持 Git 的日期格式，例如：
+
+- 具体日期：`2023-01-01`
+- 相对日期：`1 month ago`, `last week`, `yesterday`
+- 特殊关键词：`now`, `today`, `last Monday`
+
+## 多仓库自动处理功能
+
+工具默认会处理配置文件中的所有仓库：
+
+1. 自动获取所有配置仓库的Git提交记录
+2. 合并所有仓库的日志，并在每条记录前加上仓库标识
+3. 将所有仓库的日志一起发送给AI进行总结
+4. 生成包含所有项目工作内容的统一总结
+
+如果希望仅处理本地仓库，可以使用 `--local` 参数。
+
+## 注意事项
+
+- 确保已安装 Git 并可在命令行中使用
+- 确保配置文件中有正确的作者名称和仓库路径
+- 使用AI总结功能需要有效的DeepSeek API密钥
+- 配置文件保存在用户主目录下的 `.git-user-log-config.json` 文件中
+
+## 问题反馈
+
+如果遇到任何问题或有改进建议，请提交 issue 或联系开发者。
+
+## 许可证
+
+MIT 
+
+## AI提供商支持
+
+工具支持多种AI提供商的API：
+
+1. **DeepSeek API (默认)**
+   - 基础URL: https://api.deepseek.com
+   - 推荐模型: deepseek-chat
+
+2. **OpenAI API**
+   - 基础URL: https://api.openai.com
+   - 推荐模型: gpt-3.5-turbo, gpt-4
+
+切换提供商示例：
+```bash
+# 切换到OpenAI
+g2log --set-api-provider="openai"
+g2log --set-api-url="https://api.openai.com"
+g2log --set-ai-model="gpt-3.5-turbo"
+
+# 切换回DeepSeek
+g2log --set-api-provider="deepseek"
+g2log --set-api-url="https://api.deepseek.com"
+g2log --set-ai-model="deepseek-chat"
+```
+
+## 流式输出
+
+当使用OpenAI API时，工具会启用流式输出功能，让您能够实时看到AI生成内容的过程，无需等待整个响应完成。这提供了更好的用户体验，特别是当处理大量提交记录时。