AGENTS.md 中的项目说明可为 Codex 提供关于你的文档标准、组件和样式指南的持久 context。
开始使用
- 一个可访问 Codex 的 OpenAI 账户
- 安装 Codex CLI:
- 进入你的文档目录。
- (可选)将下面的
AGENTS.md文件添加到你的项目中。 - 运行
codex启动会话。
将 Codex 与 Mintlify 配合使用
AGENTS.md 文件,以了解项目特定的规则和约定。你可以在文档仓库的根目录中放置一个 AGENTS.md 文件,为 Codex 提供有关 Mintlify 组件、写作标准以及你如何组织文档结构的 context。
Codex 会在多个层级发现 AGENTS.md 文件:
- 全局说明位于
~/.codex/AGENTS.md,适用于你的所有项目。 - 项目说明位于你的仓库根目录(或任何子目录),适用于该范围内的工作。
AGENTS.md 并提交,让所有贡献者都能受益于相同的 context。完整详情请参阅 Codex 文档中的 AGENTS.md。
示例 AGENTS.md
- 写作标准:更新语言规范以符合你的风格指南。
- 组件模式:添加项目特定的组件,或修改现有示例。
- 代码示例:将通用示例替换为与你的产品相关的真实 API 调用与响应。
- 风格与语气偏好:调整术语、格式和其他规则。
AGENTS.md。
AGENTS.md
使用 Codex
AGENTS.md 的配置后,当你在文档仓库中启动会话时,Codex 会自动读取该文件。
示例提示
使用 MCP 服务器增强功能
~/.codex/config.toml 的全局 Codex 配置中: