Gitrama — Git 历史智能分析工具

Gitrama 是一款命令行工具（CLI），为您的 Git 历史提供由 AI 驱动的语义搜索与智能分析能力。它内置了 AI 助手 AskGIT，可全面理解您整个代码仓库的上下文。

所有 AI 处理均在服务端通过 api.gitrama.ai 完成。无需 API 密钥——安装后即可直接使用。

核心能力

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

用自然语言向您的代码仓库提问：

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

命令：gtr chat

AskGIT 会自动调用 10 个 git 子命令（获取分支信息、近期提交、diff 内容、贡献者列表、文件树等）收集上下文，并将该上下文发送至 api.gitrama.ai 进行智能分析。

2. 智能提交消息生成

基于暂存区（staged）的变更自动生成符合规范的提交消息：

• 分析您的 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

配置

无需 API 密钥或额外配置。Gitrama 开箱即用，所有 AI 处理均通过 api.gitrama.ai 完成。

如需进行可选配置，可执行：

gtr config

使用示例

当用户就 Git 历史或仓库上下文发起提问时，请运行对应的 Gitrama 命令：

# 启动关于当前仓库的交互式对话
gtr chat

# 为暂存区变更生成提交消息
gtr commit

# 生成分支名称
gtr branch "add user authentication with OAuth"

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

数据流向

本地 CLI（gtr）→ 在本地收集 Git 上下文 → POST 至 api.gitrama.ai → 获取 AI 响应

• Git 上下文（提交记录、diff、分支信息等）通过本地 git 子进程调用收集
• 上下文被发送至 api.gitrama.ai 进行 AI 处理
• 用户本地设备不存储也不需要任何 API 密钥
• 敏感逻辑（AI 智能层）完全运行于服务端，本地无敏感 IP 执行

重要说明

• Gitrama 必须在 Git 仓库目录内运行
• AskGIT 维护最多 40 条消息的多轮对话历史，以支持上下文连贯性
• 工具自动收集仓库上下文——无需手动配置
• 发送至 api.gitrama.ai 的仓库数据仅用于生成响应，不会被持久化存储

错误处理

若安装后无法找到 gtr 命令：

# 确保 pip 的 scripts 目录已加入 PATH
python3 -m gitrama --version

若出现连接错误：

# 验证 api.gitrama.ai 是否可访问
curl -s https://api.gitrama.ai/health

相关链接

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