OpenAI Codex 的 local environments 用来给 worktree 配置初始化步骤和常用操作,适合需要自动安装依赖、执行构建或快速启动测试/开发命令的项目。配置在 Codex app settings 里完成,生成的文件会保存在项目根目录的 .codex 中;如果命令因平台不同而不同,可以分别为 macOS、Windows 和 Linux 覆盖脚本。
OpenAI Codex 本地环境配置
OpenAI Codex 的 local environments 主要解决两类问题:新建 worktree 时如何自动完成环境准备,以及如何把项目里常用的命令做成可点击的 actions。
配置入口在 Codex app settings 面板。生成的配置文件会写入项目根目录的 .codex 文件夹,你也可以把它提交到 Git 仓库,方便团队共享。
如果一个仓库里包含多个项目,请打开那个包含共享 .codex 文件夹的项目目录。
Setup scripts
worktree 运行在和本地任务不同的目录里,所以项目可能还没有完全准备好,缺少依赖或仓库里没有提交的文件。Codex 在新线程开始、创建新的 worktree 时,会自动运行 setup scripts。
把需要完成环境配置的命令写进这里,例如安装依赖或执行构建流程。
例如,TypeScript 项目可以在 setup script 里先安装依赖,再做一次初始构建:
npm install
npm run build
如果你的 setup 需要按平台区分,可以分别定义 macOS、Windows 或 Linux 的脚本,覆盖默认脚本。
Actions
Use actions to define common tasks like starting your app’s development server or running your test suite. These actions appear in the Codex app top bar for quick access. The actions will be run within the app’s integrated terminal.
Actions are helpful to keep you from typing common actions like triggering a build for your project or starting a development server. For one-off quick debugging you can use the integrated terminal directly.
例如,Node.js 项目可以创建一个名为 “Run” 的 action,内容如下:
npm start
如果 action 里的命令因平台不同而不同,也可以分别为 macOS、Windows 和 Linux 定义平台专用脚本。
为了方便识别,每个 action 都应该选择一个相关的图标。
常见问题
OpenAI Codex 本地环境配置会保存到哪里
配置会保存在项目根目录的 .codex 文件夹里。你可以把生成的文件提交到 Git 仓库,和团队成员共享。
setup scripts 什么时候会执行
当 Codex 在新线程开始时创建新的 worktree,setup scripts 会自动执行。它适合做依赖安装、构建等环境准备工作。
actions 和 integrated terminal 有什么区别
actions 是放在 Codex app 顶栏里的常用任务入口,会在 app 的 integrated terminal 中运行。临时排查问题时,也可以直接打开 integrated terminal 手动执行命令。