tlai-commit

基于 AI 的智能代码提交工具，为企业内部开发提供结构化的提交信息生成。支持多种 AI 模型服务。

特性

• 🤖 使用 AI 分析代码变更并生成提交信息（支持 DeepSeek、OpenAI 等）
• 📝 结构化的 Markdown 格式提交信息
• ✅ 用户确认和编辑功能
• ⚙️ 简单的配置管理
• 🚀 支持别名 tlc

安装

全局安装

npm install -g tlai-commit

快速开始

1. 配置 AI API Key 和 URL

#查看当前配置
tlai-commit config list
#或者
tlc config list

# 配置 API Key
tlai-commit config set API_KEY <your-api-key>

# 配置 API URL (可选，默认为 DashScope 兼容模式 v1)
tlai-commit config set API_URL <your-api-url>

# 或使用别名
tlc config set API_KEY <your-api-key>
tlc config set API_URL <your-api-url>

2. 使用工具

# 生成并提交（将自动执行 git add .）
tlai-commit
# 或使用别名
tlc

使用流程

1. 自动暂存: 在生成提交信息前自动执行 git add .
2. 运行工具: 执行 tlai-commit 或 tlc
3. AI 分析: 工具会分析暂存的代码变更
4. 生成信息: AI 生成结构化的提交信息
5. 用户确认: 你可以确认、编辑或取消提交
6. 执行提交: 确认后自动执行 git commit

配置选项

查看配置

tlc config list

设置配置

# 设置模型
tlc config set model qwen-plus

# 设置最大令牌数
tlc config set max_tokens 2000

# 设置温度参数
tlc config set temperature 0.7

可用配置

• API_KEY: AI API Key (必需)
• API_URL: AI API URL，默认 https://dashscope.aliyuncs.com/compatible-mode/v1
• model: 使用的模型，默认 qwen-plus
• max_tokens: 最大令牌数，默认 2000
• temperature: 温度参数，默认 0.7

提交信息格式

生成的提交信息采用结构化 Markdown 格式：

# 提交标题

## 变更概述
- 简要说明本次提交的主要目的

## 具体变更
- 文件1: 修改说明
- 文件2: 修改说明

## 影响范围
- 对系统的影响描述

## 测试建议
- 验证建议

## 关联信息
- 问题背景或业务上下文

开发

构建项目

npm run build

开发模式

npm run dev

代码检查

npm run lint
npm run type-check

许可证

MIT License

作者

kejian