需配置环境与触发机制以实现CodeBuddy自动生成规范Git Commit消息:一、IDE插件版(VS Code/JetBrains);二、CLI命令行版;三、Git Hook自动化集成;四、长期记忆与上下文增强;五、多语言团队适配。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如果您在使用 CodeBuddy 进行代码提交时希望自动生成符合规范的 Git Commit 消息,则需完成对应环境配置与触发机制设置。以下是实现该目标的多种配置方式:
一、IDE 插件版配置(VS Code / JetBrains)
该方式通过 IDE 内置 Git 面板集成 Smart Commit 功能,无需手动编写脚本,适合日常高频提交场景。插件自动读取暂存区变更,并基于 Conventional Commits 规范生成结构化消息。
1、确保已安装 CodeBuddy 官方插件(VS Code 商店或 JetBrains Plugin Marketplace 搜索 “CodeBuddy”)。
2、在 IDE 中打开项目,进入 Git 面板,确认待提交文件处于未暂存状态。
3、右键点击变更文件或使用快捷键 Ctrl+Shift+P(Windows/Linux)或 Cmd+Shift+P(macOS) 调出命令面板,输入 “Git: Stage All Changes” 并执行。
4、在 Git 提交消息输入框右侧,点击 “AI COMMIT” 按钮。
5、等待 3–5 秒,输入框中将自动填充如 feat(login): add password strength validation 类格式的提交信息。
6、可手动编辑内容后,按 Ctrl+Enter(Windows/Linux)或 Cmd+Enter(macOS) 完成提交。
二、CLI 命令行版配置(codebuddy generate-commit)
该方式适用于无 GUI 环境、CI/CD 流水线集成或批量提交场景,依赖本地已安装的 CodeBuddy CLI 工具,直接解析 git staged diff 并输出标准 commit message。
1、确认已全局安装 CodeBuddy CLI:npm install -g @tencent-ai/codebuddy-code。
2、执行登录命令:codebuddy login,按提示完成微信扫码或 GitHub 授权。
3、在项目根目录下,先完成文件暂存:git add . 或指定文件。
4、运行生成命令:codebuddy generate-commit。
5、终端将立即输出符合 type(scope): subject 格式的提交信息,例如:fix(auth): correct JWT token expiration check in middleware。
6、复制输出内容,粘贴至 git commit -m "..." 命令中执行提交,或直接使用 codebuddy ai-commit 一键完成生成并提交。
三、Git Hook 自动化集成(commit-msg + commitlint)
该方式将 CodeBuddy 生成结果与 Git 钩子联动,在提交前强制校验格式,确保所有团队成员提交均通过统一规范拦截,适用于规范化治理要求严格的协作项目。
1、安装 husky 和 commitlint:npm install husky @commitlint/cli @commitlint/config-conventional --save-dev。
GitHub Hosts 更新工具(仅限中国用户),安全更新系统hosts文件,保留原有非GitHub条目,仅替换GitHub相关地址。支持备份恢复和风险提示。用于解决GitHub访问问题。
2、初始化 husky:npx husky install,并在 package.json 中添加 prepare 脚本。
3、创建 commit-msg 钩子:npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'。
4、创建 commitlint.config.js 文件,启用 CodeBuddy 兼容规则,其中 type-enum 必须包含 feat/fix/docs/refactor 等常规类型。
5、在 pre-commit 钩子中调用 codebuddy generate-commit --output-only 将生成结果写入 .git/COMMIT_EDITMSG,供后续 commit-msg 钩子校验。
6、开发者执行 git commit 时,若消息不符合规范,将被 commitlint 拒绝,提示重新生成或手动修正。
四、长期记忆与上下文增强配置(/init + CODEBUDDY.md)
该方式用于提升生成质量,使 CodeBuddy 在理解项目 scope、技术栈和业务语义时具备一致性,避免每次提交都需重复解释模块归属或领域术语。
1、在项目根目录执行:codebuddy /init,触发项目结构扫描。
2、工具将自动生成 CODEBUDDY.md 文件,其中包含 detected tech stack、module boundaries、common scopes(如 auth、ui、api)等元信息。
3、手动编辑该文件,在 scopes 区域补充业务模块缩写,例如:profile → 用户档案模块。
4、在 IDE 插件设置或 CLI 配置中启用 include_co_authored_by: true,确保多人协作时自动生成 Co-authored-by 行。
5、后续所有 Smart Commit 调用将自动继承该上下文,生成如 feat(profile): expose avatar upload API with CORS support 的高精度消息。
五、多语言与团队适配配置(中文/英文切换)
该方式支持混合开发团队在统一规范下按成员偏好输出不同语言的 commit message,避免翻译偏差导致语义失真,同时保持 Git 历史可检索性。
1、在 JetBrains IDE 中,进入 Settings → Tools → CodeBuddy → Smart Commit,选择默认语言为 中文 或 English。
2、在 VS Code 中,打开设置(Ctrl+,),搜索 codebuddy.smartCommit.language,设为 zh-CN 或 en-US。
3、CLI 用户可在配置文件 ~/.codebuddy/config.yaml 中设置:language: zh-CN。
4、生成示例(中文):修复(登录模块):修正验证码过期后仍可提交的问题。
5、生成示例(英文):fix(login): prevent form submission after captcha expires。

















