Gitrama — Git 历史智能分析工具

Gitrama 是一个 CLI 工具，为你的 Git 历史提供基于 AI 的语义搜索与智能分析功能。它包含 AskGIT，一个嵌入式 AI 助手，能够理解你整个代码仓库的上下文。

功能特性

1. AskGIT — 语义化 Git 历史对话

使用自然语言提问关于代码仓库的问题：

• “上个月对认证模块做了哪些修改？”
• “API 层的主要贡献者是谁？”
• “总结最近 20 次提交”
• “v1.0 到 v2.0 之间发生了哪些破坏性变更？”

命令： gtr chat

AskGIT 会自动从 10 个 Git 子命令调用中收集上下文（如分支信息、最近提交、差异内容、贡献者、文件树结构），并据此给出智能回答。

2. 智能提交信息生成

根据暂存的更改自动生成符合规范的提交信息：

• 分析 git diff --staged 的内容
• 生成格式正确的常规提交信息（feat:, fix:, docs: 等）
• 遵循项目约定的提交规范

命令： gtr commit

3. 分支名称生成

根据任务描述生成清晰、有意义的分支名称：

• 符合 Git 分支命名规范
• 包含类型前缀（feature/, bugfix/, hotfix/）
• 名称简洁且具有描述性

命令： gtr branch

4. Git 日志分析与仓库洞察

获取基于 AI 的仓库分析报告：

• 贡献者活动模式
• 各模块代码变更频率
• 发布历史摘要
• 技术债指标

命令： gtr chat，然后提出关于仓库洞察的问题

安装方式

Gitrama 通过 PyPI 发布：

pip install gitrama

验证安装是否成功：

gtr version

配置说明

Gitrama 的 AI 功能需要配置 API 密钥。可通过环境变量设置：

export ANTHROPIC_API_KEY=your-key-here

或通过以下命令配置：

gtr config

使用示例

当用户需要查询 Git 历史或仓库上下文时，运行相应的 Gitrama 命令：

# 启动与仓库相关的交互式对话
gtr chat

# 为暂存的更改生成提交信息
gtr commit

# 根据任务描述生成分支名称
gtr branch "add user authentication with OAuth"

# 快捷命令
gtr c   # commit 的别名
gtr b   # branch 的别名
gtr ch  # chat 的别名

重要提示

• Gitrama 必须在 Git 仓库内部运行
• AskGIT 维护最多 40 条消息的对话历史，支持多轮对话
• 工具会自动收集仓库上下文，无需手动配置
• 所有 AI 处理均通过 api.gitrama.ai 进行服务器端处理，不会在本地运行敏感代码

错误处理

如果安装后无法找到 gtr 命令：

# 确保 pip 脚本在 PATH 中
python3 -m gitrama --version

如果出现 API 密钥错误：

# 验证密钥是否已正确设置
echo $ANTHROPIC_API_KEY

相关链接

• 官方网站：https://gitrama.ai
• PyPI 页面：https://pypi.org/project/gitrama/