CodeBuddy 可自动生成专业 README：支持 Craft 模式一键生成、CLI 批量生成、Chat 定制化生成三种方式，精准识别技术栈与脚本，覆盖快速开始、技术栈、目录结构、开发脚本、贡献指南五大模块。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
你想给刚初始化的前端组件库项目快速配上一份专业、可维护的 README，但手动写容易遗漏技术栈说明、安装步骤或本地开发命令——CodeBuddy 能基于真实代码结构自动生成带版本号、依赖列表和 CLI 指令的完整文档，无需你逐行回忆 npm script 名称。
用 Craft 模式一键生成项目级 README
这一步操作起来很简单，直接把文件拖进去就行。在 CodeBuddy IDE 中打开项目根目录 → 点击左侧边栏「Craft」标签 → 在输入框中输入指令：/generate-readme for @workspace。
系统将自动扫描 package.json、tsconfig.json、eslint.config.js、.vscode/settings.json 及 src/ 目录结构，识别出框架类型（Vue 3 + TypeScript）、包管理器（pnpm）、构建工具（Vite）和代码规范配置。
生成的 README.md 会包含「快速开始」「技术栈」「目录结构」「开发脚本」「贡献指南」五大模块，其中「开发脚本」部分精确列出 pnpm dev → pnpm build → pnpm lint 三条命令，【与 package.json 中 scripts 字段完全一致，不会凭空编造】。
用 CLI 命令批量生成多项目 README
方法一：全局执行生成
在终端进入公司 monorepo 根目录，运行：codebuddy readme --all --format markdown。
方法二：指定子包生成
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 问题
进入 packages/ui-core 子目录，执行：codebuddy readme --scope ui-core --output README.md。
注意：该命令要求当前目录下存在有效的 package.json，且 name 字段不为空；若缺失，CLI 将跳过该目录并报错提示。
在 Chat 模式中定制化生成
第一步：在 Chat 输入框中发送：请为这个 Vue 组件库生成 README，重点突出 TypeScript 类型支持、Volar 插件配置建议、以及如何在 Nuxt 项目中按需引入组件。
第二步：点击右下角「Attach Codebase」按钮，勾选 src/components/ 和 types/ 目录，确保 CodeBuddy 能读取 .d.ts 声明文件和组件源码。
第三步：等待响应完成后，点击生成内容右上角的「Copy」图标 → 新建 README.md 文件 → 粘贴保存。
这一步必须手动粘贴，因为 Chat 模式默认不写入文件系统；【若直接点击“Save as README”却未弹出保存对话框，请检查 IDE 是否授予了 CodeBuddy 文件写入权限】。
