Sources
S1 — Codex CLI features
URL: https://developers.openai.com/codex/cli/features
- 权威: 官方文档
- 支撑: Codex CLI 可读仓库、编辑文件、运行命令、展示 plan/diff、审批步骤,以及交互式工作流适合实时审阅。
- 关键事实: Codex CLI 交互模式支持在项目中读写和运行命令;用户可看计划、审 diff、批准或拒绝步骤。
S2 — Codex prompting
URL: https://developers.openai.com/codex/prompting
- 权威: 官方文档
- 支撑: 给 Codex 写任务时要提供目标、上下文、约束、成功标准和工具边界。
- 关键事实: 高质量 Codex prompt 应把任务、范围、约束和验收说清,避免只写模糊愿望。
S3 — Custom instructions with AGENTS.md
URL: https://developers.openai.com/codex/guides/agents-md
- 权威: 官方文档
- 支撑:
AGENTS.md的发现顺序、全局与项目指令叠加、靠近当前目录的指令覆盖早先指导。 - 关键事实: Codex 会在工作前读取
AGENTS.md等项目指导,按全局到项目路径逐层合并。
S4 — Permissions
URL: https://developers.openai.com/codex/permissions
- 权威: 官方文档
- 支撑: permission profiles、filesystem/network 边界、内置
:read-only、:workspace、:danger-full-access。 - 关键事实: 权限 profile 用于给 Codex 运行的本地命令设置最小权限;全权限应只在确实需要时使用。
S5 — Codex app Review
URL: https://developers.openai.com/codex/app/review
- 权威: 官方文档
- 支撑: Review pane 展示 Git 仓库变化、可切换 diff 范围、可使用 inline comments 指导 Codex。
- 关键事实: Review pane 反映 Git 当前状态,可能包含 Codex、用户或其他未提交改动。
S6 — Agent internet access
URL: https://developers.openai.com/codex/cloud/internet-access
- 权威: 官方文档
- 支撑: Codex web/cloud 联网默认边界、联网风险、域名 allowlist 和 HTTP 方法限制。
- 关键事实: 代理联网会增加 prompt injection、泄露 secrets、下载恶意依赖等风险,应限制域名和方法。
S7 — Codex app Worktrees
URL: https://developers.openai.com/codex/app/worktrees
- 权威: 官方文档
- 支撑: Codex app worktree 的用途、Git worktree 基础、并行任务和 Handoff。
- 关键事实: Worktrees 让 Codex 在同一项目中并行运行独立任务,减少对本地前台工作的干扰。
S8 — generate-course-from-topic SKILL.md
URL: local:agent-mentor/skills/generate-course-from-topic/SKILL.md
- 权威: 官方文档
- 支撑: 本课程生成 skill 的触发描述、七段工序、取材边界、交付物和
glossary.json要求。 - 关键事实: 该 skill 将任意主题生成结构稳定的 Markdown 自学课,交付物包含 README、课节、sources 和 glossary。
S9 — course-guard.mjs
URL: local:scripts/course-guard.mjs
- 权威: 官方文档
- 支撑: guard 的机械检查项:引用、死链、模板段、README 覆盖、frontmatter、glossary、源权威。
- 关键事实:
node scripts/course-guard.mjs <课目录>是课程交付前必须通过的确定性检查。
S10 — Agent Skills
URL: https://developers.openai.com/codex/skills
- 权威: 官方文档
- 支撑: Codex skills 的目录结构、progressive disclosure、显式/隐式触发方式、description 的作用。
- 关键事实: Codex 先看到 skill 的 name、description 和路径;任务匹配后才读取完整
SKILL.md。
S11 — agent-mentor-skill README
URL: local:README.md
- 权威: 官方文档
- 支撑: 本包面向 Codex 等本地 coding agent,用户说"我想学 X"即可触发生成课程;README 解释一句话触发原因。
- 关键事实: 本仓库 README 明确把
generate-course-from-topic设计成自然语言触发的课程生成 workflow。
S12 — course-authoring-guide.md
URL: local:agent-mentor/skills/generate-course-from-topic/course-authoring-guide.md
- 权威: 官方文档
- 支撑: 课程写作七段细则、sources 权威字段、正文脚注、练习四件套和 guard 后自查。
- 关键事实: 课程必须有来源、固定骨架、worked/faded/独立练习阶梯,并在 guard 后按 rubric 自查。