可一键生成结构清晰、内容详实的 README 文档：一、Chat 模式自然语言请求；二、Craft 模式加载 README 指令文件；三、CLI 命令模板化生成；四、配置自定义指令语义化触发。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
如果您希望为新项目快速生成结构清晰、内容详实的 README 文档，但手动编写耗时且易遗漏关键信息，则可能是由于缺乏标准化模板与上下文感知能力。以下是实现一键生成项目 README 文档的多种可行方法：
一、在 Chat 模式中直接请求生成
CodeBuddy 的 Chat 模式支持自然语言指令，可依据项目类型自动推断所需文档结构，并输出符合开源规范的 Markdown 格式内容。该方式无需配置，适合快速原型阶段或单次使用场景。
1、打开 CodeBuddy 的 Chat 界面，输入明确需求，例如：“请为一个批量转换 PPT/Excel/Word 为 PDF 的 Python 工具生成完整的 README.md 文件”。
2、等待模型响应，确认生成内容包含标题、简介、安装步骤、使用示例、依赖列表、许可证等核心章节。
3、复制返回的 Markdown 内容，在本地项目根目录新建 README.md 文件并粘贴保存。
二、通过 Craft 模式加载 README 指令文件
Craft 模式支持基于已有文档进行代码生成与工程初始化，若已存在一份标准 README 模板或历史项目文档，可将其作为输入源驱动后续开发流程。此方式适用于团队协作或需复用文档风格的场景。
1、将已生成或预设的 README.md 文件上传至当前工作区，或在本地创建后拖入 Craft 编辑区域。
2、在指令栏中输入 @README.md 并执行，CodeBuddy 将解析文档中的功能描述、技术栈、接口定义等信息。
3、系统自动匹配对应框架与模块结构，生成初始化代码骨架、配置文件及测试用例，同时保留 README 中的关键说明文字。
三、使用 CLI 命令触发模板化生成
CodeBuddy CLI 提供命令行驱动的文档生成能力，支持结合项目元数据（如 package.json、pyproject.toml）自动生成适配当前语言生态的 README，具备高度可重复性与脚本集成能力。
1、确保已安装 CodeBuddy CLI 并完成 Node.js 环境配置，运行 codebuddy --version 验证可用性。
2、进入目标项目根目录，在终端中执行：codebuddy init readme --lang python --type tool。
3、CLI 将读取项目配置，填充作者、版本、命令行参数等动态字段，输出标准格式的 README.md 到当前路径。
四、配置自定义指令实现语义化触发
对于高频使用的文档类型，可通过预设自定义指令实现一键唤起特定 README 模板，避免每次重复描述需求。该方式依赖 .codebuddy/commands 目录下的指令定义文件，强调语义一致性与团队规范统一。
1、在项目根目录下创建 .codebuddy/commands/readme-tool.yaml 文件。
2、写入如下内容：description: “生成面向工具类项目的 README”；alwaysapply: false；enabled: true；provider: “template-readme-tool-v1”。
3、重启 CodeBuddy 后，在任意界面输入 /readme-tool 即可触发模板渲染，结果自动插入编辑器光标位置。
