在项目文档编写中，一个高质量的 README 往往决定开发者能否快速上手，但实际动手时容易遗漏关键信息、手动调整 Markdown 格式，还要反复核对安装步骤和使用示例是否完整。如果你正为这些琐碎细节头疼，CodeBuddy 提供的多种“一键生成”方式确实值得深入了解。下面逐一拆解四种实用途径。

该工具支持通过对话、加载指令文件、命令行以及自定义快捷指令四种方式，快速输出结构清晰、内容完整的 README 文档。我们来逐一分析具体操作。

一、在 Chat 模式中直接请求生成

Chat 模式本质上是与 AI 直接对话。你只需描述项目用途，AI 就能自动推断所需章节，输出一份符合开源规范的 Markdown 文件。这种方式非常适合快速原型阶段或仅需单次生成、不想做任何配置的场景。

第一步，打开 CodeBuddy 的聊天界面，输入类似这样的指令：“请为一个批量将 PPT、Excel、Word 转换为 PDF 的 Python 工具生成完整的 README.md 文件”。注意需求要明确，项目类型和功能需说清楚。

第二步，等待模型响应。生成的文档通常包含标题、简介、安装步骤、使用示例、依赖列表、许可证等核心模块，基本无需额外补充。

第三步，将返回的 Markdown 内容复制到项目根目录，新建一个 README.md 文件，粘贴保存即可完成。

二、通过 Craft 模式加载 README 指令文件

如果你已有标准 README 模板，或希望复用之前项目的文档风格，Craft 模式会更顺手。它允许基于已有文档生成代码或初始化工程，对团队协作或保持风格统一的场景非常实用。

操作上，先将已有的 README.md 文件上传到工作区，或本地创建后拖入 Craft 编辑区域。然后在指令栏输入 @README.md 并执行，CodeBuddy 会解析文档中的功能描述、技术栈、接口定义等信息。随后自动匹配框架结构，生成初始化代码骨架、配置文件及测试用例，同时保留 README 中的关键说明文字。

三、使用 CLI 命令触发模板化生成

对于习惯命令行的开发者，CLI 模式提供了另一种选择。它可直接读取项目元数据（如 package.json、pyproject.toml），自动生成适配当前语言生态的 README。可重复性强，也便于集成到脚本或 CI/CD 流程中。

前提是已安装 CodeBuddy CLI 且 Node.js 环境正常，先运行 codebuddy --version 验证。然后进入目标项目根目录，在终端执行类似命令：codebuddy init readme --lang python --type tool。CLI 会读取项目配置，自动填充作者、版本、命令行参数等动态字段，最终输出标准格式的 README.md 到当前路径。

四、配置自定义指令实现语义化触发

如果你频繁需要某类文档（例如工具类项目的 README），可通过预设自定义指令实现一键唤起特定模板。这样每次无需重复描述需求，直接输入快捷命令即可。

配置并不复杂。在项目根目录创建 .codebuddy/commands/readme-tool.yaml 文件，写入：description: “生成面向工具类项目的 README”；alwaysapply: false；enabled: true；provider: “template-readme-tool-v1”。保存后重启 CodeBuddy，在任意界面输入 /readme-tool 即可触发模板渲染，结果会自动插入到编辑器光标位置。