Skip to content

Latest commit

 

History

History
152 lines (117 loc) · 3.76 KB

README.md

File metadata and controls

152 lines (117 loc) · 3.76 KB

devlog-generator

Version Node License JavaScript TypeScript

Markdown HTML5 JSON

🚀 将 Git 提交记录转化为优雅的开发日志，支持 AI 增强和多种输出格式

📖 简介

devlog-generator 是一个强大的开发日志生成工具，它可以：

  • 🎯 自动分析 Git 提交记录，生成结构化的开发日志
  • 🤖 通过多个 AI 模型优化日志内容，使其更专业、更易读
  • 🎨 支持多种输出格式，满足不同场景需求
  • ⚡ 简单易用，一键生成，告别手写日志的烦恼

✨ 特性

  • 🔄 智能提交分析
    • 自动识别提交类型（feat/fix/docs等）
    • 智能分组和归类
    • 支持按时间/标签/版本分组
  • 🤖 AI 增强
    • 支持多个主流 AI 服务
      • OpenAI (GPT-3.5/4)
      • Claude
      • Gemini
      • Kimi
    • 智能优化描述内容
    • 自动补充技术细节
  • 📝 多格式输出
    • Markdown（适合文档和 Git 仓库）
    • HTML（美观的网页展示）
    • JSON（便于程序处理）
  • ⚙️ 高度可定制
    • 灵活的配置选项
    • 自定义输出模板
    • 支持输出样式定制

🚀 快速开始

安装

# 使用 npm
npm install -g devlog-generator

# 使用 yarn
yarn global add devlog-generator

# 使用 pnpm
pnpm add -g devlog-generator

基础使用

  1. 初始化配置：
devlog init
  1. 生成日志：
devlog generate

📝 输出示例

支持三种格式输出，点击查看示例：

⚙️ 配置

配置文件

默认配置文件 devlog.config.json 示例：

{
  "useAI": true,
  "aiInterface": "gemini",
  "openai": {
    "apiKey": "",
    "model": "gpt-3.5-turbo",
    "stylePrompt": "Generate formal and technical logs"
  },
  "claude": {
    "apiKey": "",
    "model": "claude-3-opus-20240229"
  },
  "gemini": {
    "apiKey": "your-gemini-api-key",
    "model": "gemini-1.5-flash"
  },
  "kimi": {
    "apiKey": "",
    "model": "moonshot-v1-128k"
  },
  "logFormat": "markdown",
  "gitLogOptions": {
    "maxCommits": 50,
    "groupSize": 5,
    "groupByTag": false,
    "includeTags": false,
    "from": "2024-01-01",
    "to": "2024-12-31"
  },
  "outputDirectory": "./public"
}

环境变量

也支持通过环境变量进行配置：

USE_AI=true
AI_INTERFACE=gemini
GEMINI_API_KEY=your-gemini-api-key
LOG_FORMAT=markdown
OUTPUT_DIRECTORY=./public

🤝 贡献

欢迎提交 PR 和 Issue！

📄 许可证

MIT

🙏 鸣谢