启动文档需在执行 /init 后生成,包含①环境要求、②分端依赖安装、③环境变量必填项与默认值、④前后端分离启动步骤及端口配置、⑤首次运行前必须执行的初始化操作(如 migrate/seed/build)。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要为一个刚接手的全栈项目快速产出一份清晰、可执行的启动文档,让新成员5分钟内就能跑起来,而不是在 package.json、.env、端口冲突和依赖版本中反复踩坑。
确认项目上下文与基础识别
打开 Codex 桌面端,确保已切换至「用于编程」工作模式。在终端中进入项目根目录(【必须是含 package.json 或 pyproject.toml 的真实项目根目录】),运行 codex 启动工具。
输入斜杠命令 /init。Codex 将自动扫描目录结构、读取配置文件、识别技术栈(如 Vue + Express + PostgreSQL)、检测启动脚本(scripts.start / scripts.dev)及环境变量约定(.env.example 是否存在)。
这一步不可跳过——若跳过,Codex 会按通用模板生成文档,大概率漏掉本地调试代理配置、数据库初始化命令或前端 mock server 启动方式。
触发启动文档生成指令
方法一:精准指令式(推荐)
在已加载项目的对话窗口中,直接输入:
“请为开发人员编写一份中文启动文档,包含:① 环境要求(Node.js/Python/Java 版本)、② 依赖安装命令(区分前端/后端)、③ 环境变量配置说明(标出必填项和默认值)、④ 启动步骤(前后端是否需分离启动?端口是否可配?)、⑤ 首次运行前必须执行的初始化操作(如 migrate、seed、build)。”
通过 Codex CLI 生成图片,支持尺寸控制和批量模式。依赖:codex (npm)。代理默认启用。用 generate.sh 生成单张,batch_generate.sh 批量生成游戏 UI 素材,gen_size.sh 指定尺寸。所有输出保存至 ~/.codex/generated_images/。
方法二:带约束的自然语言描述
“这是我们的全栈项目:前端用 Vue 3(Vite),后端是 NestJS,数据库用 PostgreSQL。前端启动端口是 3000,后端是 3001,但后端 API 路径被 Vite 的 proxy 代理到 /api。本地需要先建 database 名为 project_dev,并运行 npm run db:migrate。请据此生成启动文档,不要写部署相关内容。”
注意:必须在已成功执行 /init 的会话中发送该指令,否则 Codex 无法获取真实端口、脚本名和目录映射关系。
校验与补全关键路径
第一步:检查环境变量段落 → 确认 Codex 是否从 .env.example 中提取了 REACT_APP_API_BASE、DB_HOST、JWT_SECRET 等字段,并标注了「必填」或「仅开发环境需设置」;若未识别,手动发送:/mention @.env.example 再追问。
第二步:验证启动命令准确性 → 对比输出中的 npm run dev:client && npm run dev:server 是否与实际 package.json 的 scripts 字段完全一致;如有差异(例如真实命令是 yarn start:fe),立即用 /edit 命令修正该行。
第三步:确认初始化动作覆盖 → 文档中必须包含类似「首次运行前执行:cd server && npm run db:setup」的明确指令;【若缺失此步,新成员启动后将直面空数据库导致的 500 错误】。










