https://ptw-cwl.github.io/tags/codebuddy/Recent content in CodeBuddy on 言黎的个人博客Hugozh-cnSat, 15 Aug 2026 11:52:22 +0800https://ptw-cwl.github.io/posts/codebuddy-rules-guide/Sat, 15 Aug 2026 11:44:39 +0800https://ptw-cwl.github.io/posts/codebuddy-rules-guide/<p>给项目配 CodeBuddy 规则，踩了几个文档没写清楚的坑。把最后能用的做法记下来，免得以后忘了。</p> <h2 id="先说为什么写规则">先说为什么写规则</h2> <p>AI 写代码最麻烦的就是它不知道项目的来龙去脉。每个项目总有些代码之外的事——构建方式、目录约定、部署流程——每次新对话都得重新解释一遍，说多了自己也烦。规则就是把这些背景固化下来，让 AI 开工前自己读。</p> <h2 id="放哪项目级和用户级分工">放哪：项目级和用户级分工</h2> <p>规则放三个地方，分工不一样：</p> <ul> <li>项目规则：仓库里 <code>.codebuddy/rules/</code>，跟着 git 走，适合团队共享</li> <li>用户规则：系统用户目录下，本机所有项目通用，不提交</li> <li>项目根目录的 <code>CODEBUDDY.md</code>：不用元数据，适合约定特别简单的项目</li> </ul> <p>我现在的用法是：跟具体项目绑定的知识（构建方式、目录约定这类）放项目级；&ldquo;怎么创建规则&quot;这类任何项目都通用的放用户级，新建项目不用重新写一遍。</p> <h2 id="文件格式踩的第一个坑">文件格式：踩的第一个坑</h2> <p>CodeBuddy 官方有两份文档，说的不一样。IDE 里点&quot;新建规则&quot;生成的是 <code>规则名/RULE.mdc</code> 文件夹结构；命令行文档写的是 <code>.codebuddy/rules/*.md</code> 平铺，支持子目录。我一开始用 RULE.mdc，后来看别的项目发现人家用平铺。</p> <p>实测两种都能识别。平铺的好处是 git 对比直观、批量处理方便，最后统一成平铺，格式长这样：</p> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-markdown" data-lang="markdown"><span style="display:flex;"><span>--- </span></span><span style="display:flex;"><span><span style="color:#f92672">description</span>: <span style="color:#ae81ff">一句话说明规则职责</span> </span></span><span style="display:flex;"><span><span style="color:#f92672">alwaysApply</span>: <span style="color:#66d9ef">true</span> <span style="color:#75715e"># true=总是加载；false=按 globs 按需加载</span> </span></span><span style="display:flex;"><span><span style="color:#f92672">enabled</span>: <span style="color:#66d9ef">true</span> </span></span><span style="display:flex;"><span><span style="color:#f92672">globs</span>: <span style="color:#75715e"># alwaysApply: false 时才需要</span> </span></span><span style="display:flex;"><span> - <span style="color:#e6db74">&#34;**/*.md&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#f92672">updatedAt</span>: <span style="color:#e6db74">2026-08-15T12:00:00.000Z</span> </span></span><span style="display:flex;"><span><span style="color:#f92672">provider</span>: <span style="color:#ae81ff">user</span> </span></span><span style="display:flex;"><span>--- </span></span><span style="display:flex;"><span> </span></span><span style="display:flex;"><span># 规则标题 </span></span><span style="display:flex;"><span>具体内容…… </span></span></code></pre></div><p><code>provider: user</code> 表示手写的规则，CodeBuddy 靠这个区分自动生成的记忆文件。</p> <h2 id="always-别开太多">always 别开太多</h2> <p>规则是每次会话开始加载的，全开的话上下文占用很可观。我的判断标准：</p> <ul> <li>每次都必须知道的（项目概述、部署方式、规则索引）设 <code>alwaysApply: true</code></li> <li>具体语言、具体文件的规范设 <code>false</code>，再用 <code>globs</code> 限定范围，比如 <code>[&quot;**/*.java&quot;]</code>，只有改 Java 文件时才加载</li> </ul> <p>全开的不超过 5 条，剩下的能按需就按需。</p>