freestylefly/CodexGuide

CodexGuide:面向全球初学者、创作者、开发者与团队的 Codex 实践指南

TypeScript

3,782

184 commits

updated Oct 14, 2026

See the code

README

CodexGuide

面向全球初学者、创作者、开发者与团队的 Codex 实践指南

Docs Stars Forks Issues License PRs Welcome

简体中文 · English · 在线阅读 · 主题皮肤 · 学习路线 · 快速上手 · 进阶教程 · 实战案例 · 参考手册 · 社区共建图

从第一次上手,到把 Codex 接入真实工作流;帮助不同背景的人用 Codex 完成开发、创作、研究、自动化与团队协作。 如果这个项目帮你节省了摸索时间,欢迎点亮 Star,让更多人看到它。

感谢packyapi的独家赞助

在线网站

CodexGuide 的在线阅读地址是 codexguide.ai。

CodexGuide 网站首页预览

GitHub README 适合快速了解项目,真正学习时更推荐打开网站阅读:网站里有更完整的导航、搜索、侧边栏目录、截图、设置速查图、学习路线和实战案例。每篇关键资料都会尽量标注最后核对日期,方便你判断内容是否需要回到 OpenAI 官方资料重新确认。

如果你正在第一次接触 Codex,可以直接从网站的 学习路线 开始;如果你已经知道自己要用 CLI、桌面 App、Cloud 或 IDE,可以先看 快速上手 和 进阶教程。

主题皮肤

CodexGuide 的主题皮肤站地址是 theme.codexguide.ai。

CodexGuide 主题皮肤网站截图

这里可以预览 Codex Themes 的官方主题、使用方法和下载入口,适合想给 Codex 桌面工作区换上个性化视觉风格的用户。

项目愿景

Codex 正在从“帮你写代码的工具”,演进为一套覆盖 CLI、Cloud/Web、IDE extension、桌面 App、移动端协同、浏览器和自动化能力的 AI 工作流系统。

CodexGuide 想做的不是命令速查表,而是一份面向真实任务的实践知识库。它关注三个问题:

  • 怎么开始:初学者应该从哪个入口、哪个任务、哪个设置开始。
  • 怎么交付:如何把需求讲清楚,让 Codex 读项目、改文件、跑命令、给出可检查结果。
  • 怎么沉淀:如何把一次成功任务变成团队可复用的模板、规则、案例和安全边界。

这份教程主要以中文组织内容,但目标并不局限在中文用户或开发者。它也会覆盖创作者、研究者、产品、运营、技术写作者、团队负责人,以及需要把 Codex 接入日常工作的非开发场景。

适合谁

  • 第一次使用 Codex 的小白:跟着桌面 App、订阅、设置、手机协同和第一个任务跑通完整闭环。
  • 想把 Codex 用进项目的开发者:学习 CLI、IDE、Git、测试、CI、AGENTS.md、沙盒与审批。
  • 内容创作者与知识工作者:把 Codex 用在写作、PPT、资料整理、知识库、浏览器和工作流自动化里。
  • 团队负责人和工具建设者:建立团队规则、任务模板、权限边界、复盘结构和可迁移案例库。
  • 正在选入口的人:对比桌面 App、CLI、Cloud、IDE、ChatGPT 手机端和插件生态的适用场景。

❤️ 赞助商

想出现在这里? 添加微信时请备注你的产品名和项目赞助说明。

赞助商介绍
PackyCode感谢 PackyCode(PackyAPI)对本项目的独家赞助!PackyCode 是一家稳定、高效的 API 中转服务商,提供 Claude Code、Codex、Gemini 等多种中转服务,具备自动故障转移、智能路由和无限并发等功能,让 AI 编程成为真正的生产力工具。通过此链接注册,立即开始使用。
APIMart感谢 APIMart 赞助了本项目!APIMart 是专注 AI 图片/视频生成的低价 API 平台,GPT-Image-2 低至 $0.006/张,1 美元可出图 160+ 张。图片、视频一套异步 API 通吃,提交任务拿 ID、回调取结果,跑批万张不超时、换模型不改代码。按量付费、无月费,通过此注册链接注册即可开用。
PayForChatPayForChat 支持 ChatGPT、Claude 会员开通与充值:微信直付、无需海外信用卡,官方渠道为你自己的账号充值,不成功全额退款,中文售后、可开收据。点击这里注册体验。
AI-MEMBER 会员代充AI-MEMBER 面向个人用户、开发者与团队,提供 ChatGPT Plus+Pro充值、Claude Pro、Gemini Pro、Gork Super 等正价会员代充服务。点击这里了解服务,查看教程。
GetGPT ProGetGPT Pro 提供 ChatGPT、Claude 等 AI 订阅开通与充值服务,支持自助下单、快速到账与售后支持。
PPToken项目赞助。PPToken 提供 ChatGPT、Claude、Gemini 等主流 AI 模型 API 中转与密钥分发服务,支持低延迟、高可用、按量计费与订阅套餐灵活选择。
随想AI中转站感谢随想AI中转站对本项目的赞助!随想AI中转站 是一家可靠高效的 API 中继服务提供商,提供 Claude、Codex、Gemini 等的中继服务。注重隐私的中转站·无数据倒卖·无模型掺水,隐私,透明,极速售后。新账户注册每日签到就送 0.5 元测试额度,充值额度 1:1,无需订阅,按量付费。多线路冗余、跨区域容灾、自动故障切换,长链路 SSE 不中断。99.9% 可用性,关键调用从不掉队。
二狗 API接入二狗,稳如老狗。二狗 API 中转站,全站 0.1x~0.2x 超低倍率,提供 Claude / GPT / Grok 等多个国内外 100% 纯血大模型接口。

顶级 IPLC 线路 + 住宅双 ISP 冗余,确保全国范围稳定低延迟访问。欢迎各位开发者、工作室 注册使用。

你会在这里看到什么

内容说明
入门路线从安装、登录、订阅、设置、手机协同、API 连接到第一个低风险任务
入口地图解释桌面 App、CLI、Cloud、IDE、ChatGPT 和集成生态该怎么选
配置专题覆盖 CLI 选项、config.toml 和项目规则配置
工作流方法任务设计、验证方式、团队 playbook
实战案例PPT、Draw.io、浏览器、Obsidian、临床文献综述、飞书、Figma、Notion、CI 修复等场景
官方资料索引汇总 OpenAI 官方资料、GitHub 仓库和关键事实来源

推荐阅读路径

1. 第一次上手

先读 学习路线,再完成 桌面 App 下载与安装、订阅 Plus / Pro、桌面 App 总览 和 第一个任务。

2. 想用 Codex 改真实项目

从 CLI 安装与登录 开始,接着看 第一次让 Codex 改代码、AGENTS.md、沙盒与审批。

3. 想把 Codex 放进团队

先看 团队 playbook,再补齐 参考手册、沙盒与审批、排障手册 和 实战案例库。

快速入口

模块适合解决什么问题
学习路线从入门、进阶到团队化的阅读顺序
快速上手桌面 App、账号、首个任务和任务闭环
手机端协同桌面任务用 ChatGPT 手机 App 中的 Codex 入口跟进桌面任务
CLI 安装与登录在本地终端安装 Codex CLI 并完成登录
第一次让 Codex 改代码用 CLI 进入真实仓库,完成一次可检查的代码任务
平台使用区别了解 macOS、Windows、Linux 与 WSL2 的命令、路径和运行环境差异
进阶教程CLI、IDE、Cloud、权限、AGENTS.md、自动化和团队实践
参考手册OpenAI 官方资料、Codex 更新记录和参考来源
AGENTS.md给 Codex 编写项目级规则和协作边界
沙盒与审批文件、命令、网络、凭据和生产资源的安全边界
自动线程管理继续、分叉、移交和整理 Codex 任务
Cloud、IDE 与桌面 App不同 Codex 使用入口的适用场景
实战案例库可复制到真实项目的任务模板和复盘结构

内容框架

CodexGuide
├─ guide         # 学习路线
├─ start         # 快速上手
├─ advanced      # 进阶教程
├─ recipes       # 实战案例
├─ manual        # 参考手册
└─ community     # 社区共建图与贡献方向

当前已搭建:

  • Codex 桌面 App 入门路径。
  • ChatGPT 手机 App 协同桌面任务。
  • Codex CLI 和 IDE 使用路径。
  • Codex 多入口使用地图和选择建议。
  • Codex 配置与扩展专题。
  • 任务说明、提示词模板和验证方法。
  • 团队实践方法。
  • AGENTS.md 项目规则模板。
  • 沙盒、审批和安全边界说明。
  • Cloud、IDE、桌面 App、ChatGPT 使用场景对照。
  • 内容生产、知识库、浏览器、CI 修复等案例模板。
  • 在线文档站、官方资料索引和社区贡献模板。

本地预览

环境要求:

  • Node.js 22.12+,且低于 25
  • pnpm 10.33.0
pnpm install
pnpm dev

构建静态站点:

pnpm build

默认开发服务会启动 VuePress 文档站。线上版本会发布到 codexguide.ai。

设计原则

  • 官方优先:功能、价格、可用性、安全策略以 OpenAI 官方资料为准。
  • 小白友好:每个入门章节尽量说明“为什么这样做”和“什么时候不要这样做”。
  • 真实任务导向:减少抽象概念堆砌,多给可复制的任务流程、输入、输出和验证方式。
  • 安全边界清晰:涉及文件写入、命令执行、联网、凭据、浏览器和电脑操控时明确风险。
  • 可沉淀:鼓励把一次成功任务整理成 AGENTS.md、模板、案例、复盘和团队规范。

Star 趋势图

Star History Chart

社区共建

欢迎加入 CodexGuide 交流群,与同频伙伴一起交流 Codex 使用经验、实践案例和最新动态。点击加入 Codex 交流群即可加入,也欢迎微信扫码关注公众号 苍何,获取更多 AI 工具与效率实践。

微信扫码关注公众号苍何

事实来源

本仓库优先引用官方资料,并会在关键页面标注“最后核对日期”。当前骨架参考:

参与贡献

欢迎提交:

  • 新手友好的教程改写。
  • 可复现的真实案例。
  • 常见错误和解决方案。
  • 团队实践、模板和工作流。
  • 官方文档变更同步。

请先阅读 贡献指南。如果你还不确定怎么贡献,可以从 社区共建图 或 good first issue 开始。

开源协议

本项目采用 MIT License 开源。你可以在保留许可声明的前提下自由使用、修改、分发与二次开发。

声明

本项目是社区维护的 Codex 实践知识库,并非 OpenAI 官方项目。涉及功能、计划、价格、可用性和安全策略等时间敏感信息时,请以 OpenAI 官方资料为准。

freestylefly/CodexGuide

CodexGuide:面向全球初学者、创作者、开发者与团队的 Codex 实践指南

TypeScript

3,782

184 commits

updated Oct 14, 2026

See the code

README

CodexGuide

面向全球初学者、创作者、开发者与团队的 Codex 实践指南

Docs Stars Forks Issues License PRs Welcome

简体中文 · English · 在线阅读 · 主题皮肤 · 学习路线 · 快速上手 · 进阶教程 · 实战案例 · 参考手册 · 社区共建图

从第一次上手,到把 Codex 接入真实工作流;帮助不同背景的人用 Codex 完成开发、创作、研究、自动化与团队协作。 如果这个项目帮你节省了摸索时间,欢迎点亮 Star,让更多人看到它。

感谢packyapi的独家赞助

在线网站

CodexGuide 的在线阅读地址是 codexguide.ai。

CodexGuide 网站首页预览

GitHub README 适合快速了解项目,真正学习时更推荐打开网站阅读:网站里有更完整的导航、搜索、侧边栏目录、截图、设置速查图、学习路线和实战案例。每篇关键资料都会尽量标注最后核对日期,方便你判断内容是否需要回到 OpenAI 官方资料重新确认。

如果你正在第一次接触 Codex,可以直接从网站的 学习路线 开始;如果你已经知道自己要用 CLI、桌面 App、Cloud 或 IDE,可以先看 快速上手 和 进阶教程。

主题皮肤

CodexGuide 的主题皮肤站地址是 theme.codexguide.ai。

CodexGuide 主题皮肤网站截图

这里可以预览 Codex Themes 的官方主题、使用方法和下载入口,适合想给 Codex 桌面工作区换上个性化视觉风格的用户。

项目愿景

Codex 正在从“帮你写代码的工具”,演进为一套覆盖 CLI、Cloud/Web、IDE extension、桌面 App、移动端协同、浏览器和自动化能力的 AI 工作流系统。

CodexGuide 想做的不是命令速查表,而是一份面向真实任务的实践知识库。它关注三个问题:

  • 怎么开始:初学者应该从哪个入口、哪个任务、哪个设置开始。
  • 怎么交付:如何把需求讲清楚,让 Codex 读项目、改文件、跑命令、给出可检查结果。
  • 怎么沉淀:如何把一次成功任务变成团队可复用的模板、规则、案例和安全边界。

这份教程主要以中文组织内容,但目标并不局限在中文用户或开发者。它也会覆盖创作者、研究者、产品、运营、技术写作者、团队负责人,以及需要把 Codex 接入日常工作的非开发场景。

适合谁

  • 第一次使用 Codex 的小白:跟着桌面 App、订阅、设置、手机协同和第一个任务跑通完整闭环。
  • 想把 Codex 用进项目的开发者:学习 CLI、IDE、Git、测试、CI、AGENTS.md、沙盒与审批。
  • 内容创作者与知识工作者:把 Codex 用在写作、PPT、资料整理、知识库、浏览器和工作流自动化里。
  • 团队负责人和工具建设者:建立团队规则、任务模板、权限边界、复盘结构和可迁移案例库。
  • 正在选入口的人:对比桌面 App、CLI、Cloud、IDE、ChatGPT 手机端和插件生态的适用场景。

❤️ 赞助商

想出现在这里? 添加微信时请备注你的产品名和项目赞助说明。

赞助商介绍
PackyCode感谢 PackyCode(PackyAPI)对本项目的独家赞助!PackyCode 是一家稳定、高效的 API 中转服务商,提供 Claude Code、Codex、Gemini 等多种中转服务,具备自动故障转移、智能路由和无限并发等功能,让 AI 编程成为真正的生产力工具。通过此链接注册,立即开始使用。
APIMart感谢 APIMart 赞助了本项目!APIMart 是专注 AI 图片/视频生成的低价 API 平台,GPT-Image-2 低至 $0.006/张,1 美元可出图 160+ 张。图片、视频一套异步 API 通吃,提交任务拿 ID、回调取结果,跑批万张不超时、换模型不改代码。按量付费、无月费,通过此注册链接注册即可开用。
PayForChatPayForChat 支持 ChatGPT、Claude 会员开通与充值:微信直付、无需海外信用卡,官方渠道为你自己的账号充值,不成功全额退款,中文售后、可开收据。点击这里注册体验。
AI-MEMBER 会员代充AI-MEMBER 面向个人用户、开发者与团队,提供 ChatGPT Plus+Pro充值、Claude Pro、Gemini Pro、Gork Super 等正价会员代充服务。点击这里了解服务,查看教程。
GetGPT ProGetGPT Pro 提供 ChatGPT、Claude 等 AI 订阅开通与充值服务,支持自助下单、快速到账与售后支持。
PPToken项目赞助。PPToken 提供 ChatGPT、Claude、Gemini 等主流 AI 模型 API 中转与密钥分发服务,支持低延迟、高可用、按量计费与订阅套餐灵活选择。
随想AI中转站感谢随想AI中转站对本项目的赞助!随想AI中转站 是一家可靠高效的 API 中继服务提供商,提供 Claude、Codex、Gemini 等的中继服务。注重隐私的中转站·无数据倒卖·无模型掺水,隐私,透明,极速售后。新账户注册每日签到就送 0.5 元测试额度,充值额度 1:1,无需订阅,按量付费。多线路冗余、跨区域容灾、自动故障切换,长链路 SSE 不中断。99.9% 可用性,关键调用从不掉队。
二狗 API接入二狗,稳如老狗。二狗 API 中转站,全站 0.1x~0.2x 超低倍率,提供 Claude / GPT / Grok 等多个国内外 100% 纯血大模型接口。

顶级 IPLC 线路 + 住宅双 ISP 冗余,确保全国范围稳定低延迟访问。欢迎各位开发者、工作室 注册使用。

你会在这里看到什么

内容说明
入门路线从安装、登录、订阅、设置、手机协同、API 连接到第一个低风险任务
入口地图解释桌面 App、CLI、Cloud、IDE、ChatGPT 和集成生态该怎么选
配置专题覆盖 CLI 选项、config.toml 和项目规则配置
工作流方法任务设计、验证方式、团队 playbook
实战案例PPT、Draw.io、浏览器、Obsidian、临床文献综述、飞书、Figma、Notion、CI 修复等场景
官方资料索引汇总 OpenAI 官方资料、GitHub 仓库和关键事实来源

推荐阅读路径

1. 第一次上手

先读 学习路线,再完成 桌面 App 下载与安装、订阅 Plus / Pro、桌面 App 总览 和 第一个任务。

2. 想用 Codex 改真实项目

从 CLI 安装与登录 开始,接着看 第一次让 Codex 改代码、AGENTS.md、沙盒与审批。

3. 想把 Codex 放进团队

先看 团队 playbook,再补齐 参考手册、沙盒与审批、排障手册 和 实战案例库。

快速入口

模块适合解决什么问题
学习路线从入门、进阶到团队化的阅读顺序
快速上手桌面 App、账号、首个任务和任务闭环
手机端协同桌面任务用 ChatGPT 手机 App 中的 Codex 入口跟进桌面任务
CLI 安装与登录在本地终端安装 Codex CLI 并完成登录
第一次让 Codex 改代码用 CLI 进入真实仓库,完成一次可检查的代码任务
平台使用区别了解 macOS、Windows、Linux 与 WSL2 的命令、路径和运行环境差异
进阶教程CLI、IDE、Cloud、权限、AGENTS.md、自动化和团队实践
参考手册OpenAI 官方资料、Codex 更新记录和参考来源
AGENTS.md给 Codex 编写项目级规则和协作边界
沙盒与审批文件、命令、网络、凭据和生产资源的安全边界
自动线程管理继续、分叉、移交和整理 Codex 任务
Cloud、IDE 与桌面 App不同 Codex 使用入口的适用场景
实战案例库可复制到真实项目的任务模板和复盘结构

内容框架

CodexGuide
├─ guide         # 学习路线
├─ start         # 快速上手
├─ advanced      # 进阶教程
├─ recipes       # 实战案例
├─ manual        # 参考手册
└─ community     # 社区共建图与贡献方向

当前已搭建:

  • Codex 桌面 App 入门路径。
  • ChatGPT 手机 App 协同桌面任务。
  • Codex CLI 和 IDE 使用路径。
  • Codex 多入口使用地图和选择建议。
  • Codex 配置与扩展专题。
  • 任务说明、提示词模板和验证方法。
  • 团队实践方法。
  • AGENTS.md 项目规则模板。
  • 沙盒、审批和安全边界说明。
  • Cloud、IDE、桌面 App、ChatGPT 使用场景对照。
  • 内容生产、知识库、浏览器、CI 修复等案例模板。
  • 在线文档站、官方资料索引和社区贡献模板。

本地预览

环境要求:

  • Node.js 22.12+,且低于 25
  • pnpm 10.33.0
pnpm install
pnpm dev

构建静态站点:

pnpm build

默认开发服务会启动 VuePress 文档站。线上版本会发布到 codexguide.ai。

设计原则

  • 官方优先:功能、价格、可用性、安全策略以 OpenAI 官方资料为准。
  • 小白友好:每个入门章节尽量说明“为什么这样做”和“什么时候不要这样做”。
  • 真实任务导向:减少抽象概念堆砌,多给可复制的任务流程、输入、输出和验证方式。
  • 安全边界清晰:涉及文件写入、命令执行、联网、凭据、浏览器和电脑操控时明确风险。
  • 可沉淀:鼓励把一次成功任务整理成 AGENTS.md、模板、案例、复盘和团队规范。

Star 趋势图

Star History Chart

社区共建

欢迎加入 CodexGuide 交流群,与同频伙伴一起交流 Codex 使用经验、实践案例和最新动态。点击加入 Codex 交流群即可加入,也欢迎微信扫码关注公众号 苍何,获取更多 AI 工具与效率实践。

微信扫码关注公众号苍何

事实来源

本仓库优先引用官方资料,并会在关键页面标注“最后核对日期”。当前骨架参考:

参与贡献

欢迎提交:

  • 新手友好的教程改写。
  • 可复现的真实案例。
  • 常见错误和解决方案。
  • 团队实践、模板和工作流。
  • 官方文档变更同步。

请先阅读 贡献指南。如果你还不确定怎么贡献,可以从 社区共建图 或 good first issue 开始。

开源协议

本项目采用 MIT License 开源。你可以在保留许可声明的前提下自由使用、修改、分发与二次开发。

声明

本项目是社区维护的 Codex 实践知识库,并非 OpenAI 官方项目。涉及功能、计划、价格、可用性和安全策略等时间敏感信息时,请以 OpenAI 官方资料为准。

Significant stargazers

Ying Hua

35 followers · starred Jul 2026

Knight

38 followers · starred May 2026

sakulali

29 followers · starred Jun 2026