codebuddy提供四种readme生成方式：一、chat模式自然语言一键触发；二、craft模式基于代码或模板反向生成；三、cli命令行脚本化批量生成；四、自定义指令结合docs知识库语义化定制。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
你需要为新项目快速生成一份结构清晰、内容完整、能直接扔进 GitHub 仓库首页展示的 README.md，但手动写容易漏掉安装命令、环境变量说明或技术栈标注——CodeBuddy 提供四种可落地的生成路径，适配不同阶段和协作场景。
Chat 模式：一句话触发，适合单次快速生成
这一步操作起来很简单，直接把自然语言需求丢给 AI 就行，不用配置模板、不读文档、不装 CLI。
1. 打开 CodeBuddy 的 Chat 界面，在输入框中输入明确指令，例如：“请为一个基于 FastAPI 的用户认证服务生成符合开源规范的 README.md，包含标题、简介、Python 版本要求、pip 安装命令、启动方式、API 列表（含 /login 和 /me）”。
2. 等待模型响应，重点检查返回内容是否含 【必需章节：安装→使用→API 接口→许可证】，缺任何一项都可能让协作者卡在第一步。
3. 全选 Markdown 内容 → 复制 → 在本地项目根目录新建 README.md → 粘贴保存。
Craft 模式：基于代码反向生成，适合已有项目补文档
当你已经用 CodeBuddy 生成了后端模块、数据库配置和 API 路由，但 README 还是空的，就该用 Craft 模式——它会扫描你当前项目里的实际文件，提取真实依赖、端口、环境变量名，而不是靠猜。
方法一：自动解析当前工程
1. 在 CodeBuddy IDE 中点击左上角模式切换按钮，选择「Craft」。
2. 输入指令：“基于当前项目所有源码，生成一份带技术栈图标、含 .env 变量说明、含 curl 调用示例的 README.md”。
3. 点击「生成文档」，系统将自动识别 pyproject.toml 中的依赖、main.py 中的 uvicorn 启动命令、以及 models/ 目录下的数据库字段类型，填充到对应章节。
方法二：用历史模板驱动生成
1. 将团队已有的标准 README.md 文件拖入 Craft 编辑区。
2. 在指令栏输入 @README.md 并回车，CodeBuddy 会提取其中的章节结构与语气风格。
3. 再输入：“按此模板重写，适配当前项目的实际路由和配置项”，AI 将保留“部署”“贡献指南”等框架，只替换内容。
CLI 命令行：脚本化复用，适合 CI/CD 或批量初始化
如果你要为 20 个微服务项目统一生成 README，或者想把它集成进 pre-commit 钩子，CLI 是唯一可靠选择——它不依赖 UI 状态，输出稳定，且能读取 package.json 或 pyproject.toml 动态填参。
1. 确保已安装 CodeBuddy CLI：运行 codebuddy --version，返回版本号 ≥ v2.8.0 才支持 readme 子命令。
2. 进入项目根目录，执行：
codebuddy init readme --lang python --type api --author "Zhang San" --port 8000
3. CLI 将自动从 pyproject.toml 读取 dependencies，从 main.py 提取 uvicorn host/port，生成带 badge 图标和版本号的 README.md。
【注意：若项目无 pyproject.toml 或 package.json，CLI 会报错退出，不会生成空文档】
自定义指令 + Docs 知识库：对齐团队规范，避免术语混乱
当你的 README 总被 PM 批评“看不懂技术细节”或被运维吐槽“没写清楚 Redis 连接超时怎么调”，说明需要注入领域知识——Docs 知识库能强制让生成内容匹配 Spring Boot 官方术语或 Vue Router 的参数命名习惯。
第一步：激活技术栈知识
1. 点击 IDE 左下角 Docs 图标 → 搜索框输入 “Spring Boot 3.3 Actuator” → 勾选条目，状态变为“已激活”。
第二步：触发语义化生成
1. 切换回 Craft 模式，输入：“生成 README，需包含 Actuator 端点列表（/actuator/health、/actuator/metrics），并说明如何通过 management.endpoints.web.exposure.include 配置暴露范围”。
2. AI 将不再泛泛而谈“监控接口”，而是准确写出配置项名称、YAML 示例、以及 /actuator/env 返回字段含义。
第三步：人工校验关键字段
1. 在 Chat 模式中上传当前项目的 application.yml。
2. 发送：“对比 application.yml 中的 server.port 和 spring.redis.timeout，修正 README 里对应的启动命令和连接说明”。
3. 逐句核对 AI 返回的修订段落，确认 port 值、timeout 单位（ms）、以及是否遗漏 ssl: true 配置项。
