YouCommit - 柚提 🍊✨

AI 驱动的 Git Commit Message 生成器。内置 AI 服务开箱即用，也支持自带 API Key，多种格式、高度可定制。

功能特性

• ⚡ 内置 AI 服务 — 无需 API Key，购买密钥即用，开箱即用
• 🔑 AI模型渠道 — 自带 API Key，支持 OpenAI / DeepSeek / 通义千问 / 任意兼容平台
• 🤖 AI 智能生成 — 分析暂存区 diff，一键生成规范的 Commit Message
• 🌊 流式输出 — 生成内容实时逐字填入 SCM 输入框
• ** 多种提交格式** — Conventional Commits / Gitmoji / 简洁 / 详细 / 自定义
• 🌍 双语输出 — 中文 (zh-CN) / English (en-US)
• ⚡ 自动化 — 可选自动 commit + 自动 push
• 🔐 安全存储 — API Key / 密钥均使用 VS Code SecretStorage，不写入配置文件
• 🎨 自定义 Prompt — 支持 .md / .txt 模板，完全控制生成逻辑

快速开始

安装

1. 在 VS Code 扩展商店搜索 YouCommit 安装
2. 或下载 .vsix 文件，通过命令面板 Extensions: Install from VSIX... 安装

发布新版插件（维护者）

每次发布都要先更新版本号，再构建和验证 VSIX，最后发布到插件市场。以下命令在项目根目录的 PowerShell 中执行。

1. 更新版本信息

1. 修改 package.json 中的 version，例如从 0.2.12 改为 0.2.13。版本号必须递增，且不能重复发布已经存在的版本。
2. 在 CHANGELOG.md 添加本版本的变更说明。
3. 完成功能检查，并确认没有把 API Key、服务密钥或 .env 文件加入提交。

2. 构建并生成 VSIX

yarn install --frozen-lockfile
yarn ext:package
npx vsce package

说明：

• yarn ext:package 生成生产版 dist/extension.js。
• npx vsce package 收集 dist/、resources/、README 和 LICENSE，生成 you-commit-0.2.13.vsix。文件名中的版本号以 package.json 为准。
• 检查 VSIX 内容时可执行：

npx vsce ls

3. 本地安装验证

先在本机安装刚生成的包，确认插件可以激活、配置模型、读取暂存区 diff 并生成 Commit Message：

code --install-extension .\you-commit-0.2.13.vsix --force

安装后在 VS Code 执行 Developer: Reload Window，再打开一个 Git 仓库进行验证。确认无误后再发布到线上。

4. 发布到 VS Code Marketplace

首次发布或本机尚未保存 publisher 凭据时，使用具有 Marketplace 发布权限（Manage）的 Microsoft Personal Access Token 登录：

npx vsce login tardis9527

随后发布当前版本：

npx vsce publish

也可以明确发布已经生成的 VSIX：

npx vsce publish --packagePath .\you-commit-0.2.13.vsix

项目中的 yarn ext:publish 等价于执行 vsce publish，但发布前仍建议先完成上面的构建和本地验证。

5. 发布到 Open VSX（可选）

使用 Open VSX Personal Access Token，通过环境变量传入，避免把令牌写入命令历史或仓库：

$env:OVSX_PAT = "your-open-vsx-token"
npx ovsx publish .\you-commit-0.2.13.vsix -p $env:OVSX_PAT

6. 提交版本并创建标签

确认两个市场都发布成功后，再提交版本记录并推送标签：

git add package.json CHANGELOG.md README.md
git commit -m "chore: release v0.2.13"
git tag v0.2.13
git push origin main --tags

将示例中的 0.2.13 替换为本次实际版本。Marketplace、Open VSX 的令牌只保存在本机或 CI 的密钥配置中，不要写入 .env、README 或 Git 历史。

配置

首次安装后会自动弹出配置向导，也可以手动执行：

1. 打开命令面板（Ctrl+Shift+P）
2. 输入 YouCommit: 配置 AI 模型
3. 选择使用方式：

⚡ 内置服务（推荐新手）

无需配置 API Key，购买密钥即可立即使用，适合不想折腾的用户。

第一步：购买密钥

前往 购买额度 下单，支付后会收到一个 YC- 开头的服务密钥（如 YC-xxxxxxxxxxxx）。不同档位次数越多越优惠，额度可叠加购买。

第二步：切换服务模式

• 打开命令面板 → YouCommit: 配置 AI 模型 → 选择 「⚡ 内置服务（无需 API Key，购买密钥即用）」
• 或在设置中将 youcommit.serviceMode 改为 builtin

第三步：输入密钥激活

• 在上一步弹出的操作提示中点击 「输入密钥」
• 或打开命令面板 → YouCommit: 输入服务密钥
• 粘贴你的 YC- 密钥，回车即可激活

激活成功后会提示剩余次数，状态栏也会实时显示 YC: 剩余 xxx 次。

查询剩余次数

• 点击状态栏的 YC: 剩余 xxx 次 即可刷新
• 或打开命令面板 → YouCommit: 查询剩余次数
• 也可在设置页 youcommit.serviceMode 旁的快捷链接中点击「📊 查询剩余次数」

注意： 密钥首次激活时会绑定当前设备，同一密钥不可在其他设备使用。如需在多台设备使用，请分别购买。多次购买的额度会自动叠加到同一设备。

🔑 AI模型渠道（自带密钥）

适合已有 AI 平台账号的用户，支持 OpenAI / DeepSeek / 通义千问等兼容平台。

1. 打开命令面板 → YouCommit: 配置 AI 模型
2. 选择 AI 平台（如 DeepSeek）→ 输入你的 API Key → 选择模型
3. 自动验证连接，成功后即可使用

更换 API Key

• 在设置页 youcommit.provider.baseUrl 下方点击「🔑 更换 API Key」
• 或打开命令面板 → YouCommit: 设置 API Key

使用

1. 使用 git add 暂存你的代码改动
2. 点击源代码管理标题栏的 ✨ 图标，或按快捷键 Ctrl+Shift+G Ctrl+Shift+A
3. 输入框显示「✨ 正在生成中...」，随后 AI 逐字填入 Commit Message

常用命令一览

支持的平台（AI模型渠道）

配置项

快捷键

参与贡献

欢迎贡献代码！本地开发环境搭建、调试方式及提交流程请参阅 CONTRIBUTING.md。

开源协议

MIT