codebuddy 可自动解析复杂项目结构并生成开发文档:通过 cli 扫描生成结构化文档,craft 模式结合 ast 与多文件上下文生成精准文档,chat 模式补全环境变量等非代码信息。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如果你正面对一个结构复杂、模块分散的项目,却需要快速理清依赖关系、识别核心入口、提取技术栈信息并生成可交付的开发文档,CodeBuddy 能基于静态分析与上下文感知能力,自动完成项目结构解析与文档合成,无需手动梳理目录树或逐行阅读配置文件。
用 CLI 扫描整个项目生成结构化开发文档
该方式适用于已完成初始化但缺乏整体说明的新项目,或需向协作方交付二次开发指南的存量工程。
第一步:在终端进入项目根目录,确认 codebuddy-cli 已全局安装且登录有效账户。
第二步:执行命令:codebuddy doc --scope project --output docs/dev-guide.md。此命令会触发全路径扫描,包括 src/、packages/、scripts/、config/ 等常见目录,但【不会扫描 node_modules 或 .git 目录】,避免污染分析结果。
第三步:等待 CLI 输出“Scanned 42 files, inferred 7 modules, resolved 12 dependencies”类提示,表示结构图谱已构建完成。
第四步:打开生成的 docs/dev-guide.md,重点检查「模块职责」章节是否准确标注了 src/core/auth 为权限中心、「调用链路」图中是否显示 api-client → service → store 的数据流向——若缺失,说明部分模块未被 import 引用,需补全依赖声明。
在 Craft 模式中让 AI 主动理解当前项目上下文
当你已在 CodeBuddy IDE 中打开项目,且编辑器光标停留在某个关键文件(如 main.ts 或 app.js)时,Craft 模式能结合 AST 解析与符号引用,生成更贴合真实运行逻辑的文档。
方法一:启用全文件上下文分析模式
点击右下角 CodeBuddy 图标 → 选择 “Context Mode” → 点击 “Full File AST Parsing”。此时状态栏会显示 “Context loaded: 1832 tokens”,【只有完成此步,Craft 才能识别跨函数变量作用域和异步调用链】。
CodeBuddy Code CLI 的安装、配置与使用指南。CodeBuddy Code 是腾讯推出的 AI 驱动 CLI 编程助手,支持自然语言驱动开发。 - 必备触发词:CodeBuddy, codebuddy, AI CLI, Tencent AI coding, @tencent-ai/codebuddy-code, terminal AI assistant - 适用场景:安装 CodeBuddy CLI、配置 CodeBuddy、使用 CodeBuddy 命令、排查 CodeBuddy 问题
方法二:多文件协同上下文注入
按住 Ctrl 键(Windows/Linux)或多选 Command 键(macOS),在资源管理器中勾选 router/index.ts、store/modules/user.ts、api/user.ts 三个文件 → 右键 → “Send to CodeBuddy Context”。这一步强制 AI 将路由定义、状态管理、API 封装视为逻辑闭环,而非孤立代码块。
方法三:输入精准指令生成文档骨架
在 Craft 输入框中粘贴:“基于当前上下文,生成一份面向新成员的开发文档,包含:① 项目启动流程(从入口文件到首屏渲染);② 用户模块的数据流图(含 Vuex/Pinia action 触发时机);③ 接口请求拦截器的生效位置与错误分类策略”。
通过 Chat 模式人工校验与补全关键信息
自动生成的文档常遗漏非代码层面但至关重要的细节,比如私有 NPM 源配置、CI/CD 流水线触发规则、本地调试代理设置等。这些必须由开发者主动提供上下文才能补全。
上传 .env.example 和 package.json 文件到 Chat 界面。
发送指令:“请检查 dev-guide.md 中的‘环境变量’章节,对照 .env.example 补充每个变量的中文含义,并标注哪些变量在 CI 环境中必须显式传入(如 CI_BUILD_NUMBER)。”
核对 AI 返回的修订项,特别注意 REACT_APP_API_MOCK 是否被标注为“仅限本地开发启用,上线前必须设为 false”,这是【不可逆的安全前提】,漏写将导致生产环境启用 mock 服务。
将修订后的内容复制进 docs/dev-guide.md 对应位置。










