changelogai

changelogai

根据 Git 历史记录即时生成专业的变更日志。

开箱即用，支持 Conventional Commits。可选的 AI 模式使用 Claude 将技术性提交信息改写为面向用户的发行说明。

安装

npm install -g @ura-dev/changelogai

快速开始

# Run without installing
npx @ura-dev/changelogai

# Generate changelog since last tag
changelogai

# Grouped by category
changelogai --group

# AI-enhanced (requires ANTHROPIC_API_KEY)
changelogai --ai --group

# Write to file
changelogai --group --output CHANGELOG.md

# Prepend new release to existing changelog
changelogai --group --output CHANGELOG.md --prepend

# JSON output for CI/CD
changelogai --format json

# Suggest semver bump
changelogai --version-bump

功能

• 零配置 — 自动检测最新标签，解析 Conventional Commits
• 智能分组 — 将提交归类为功能、错误修复、性能等类别
• AI 模式 — 使用 Claude 将提交信息改写为清晰、面向用户的描述
• 多种格式 — Markdown、JSON、纯文本
• 版本升级建议 — 分析变更并建议 major/minor/patch
• 前置模式 — 将新版本内容添加到现有 CHANGELOG.md 的顶部
• 无依赖 — 纯 Node.js，随处可用

选项

标记	描述	默认值
--from <ref>	起始引用（标签/提交）	最新标签
--to <ref>	结束引用	HEAD
--output <file>	写入文件	stdout
--format <fmt>	markdown、json、plain	markdown
--group	按提交类型分组	false
--ai	使用 AI 增强描述	false
--model <model>	AI 模式使用的 Claude 模型	claude-haiku-4-5-20251001
--prepend	前置到现有文件	false
--version-bump	建议 semver 升级	false
--repo <path>	Git 仓库路径	.
--max-commits <n>	处理的提交数量上限	500

MCP 服务

changelogai 包含一个 Model Context Protocol 服务，可供 AI Agent 和 IDE 集成使用（Claude Desktop、Cursor、VS Code 等）。

{
  "mcpServers": {
    "changelogai": {
      "command": "npx",
      "args": ["-y", "-p", "@ura-dev/changelogai", "changelogai-mcp"]
    }
  }
}

如果已全局安装，也可以运行：

{
  "mcpServers": {
    "changelogai": {
      "command": "changelogai-mcp"
    }
  }
}

可用工具

工具	描述
changelogai_generate	根据 Git 历史记录生成变更日志。返回 Markdown、JSON 或纯文本。
changelogai_version_bump	分析 Git 提交并建议下一次 semver 升级（major/minor/patch）。

AI 模式

设置 Anthropic API 密钥：

export ANTHROPIC_API_KEY=sk-ant-...

然后使用 --ai 运行：

changelogai --ai --group --output CHANGELOG.md

AI 模式会将技术性提交信息改写为清晰、面向用户的发行说明。默认使用 Claude Haiku（速度快、成本低——每份变更日志约 $0.001）。

许可证

MIT