Appearance
本地环境配置(Local Environments)让你为 Worktree 定义初始化脚本,解决 Worktree 首次创建时缺少依赖的问题;同时可以定义常用操作 Actions,在 Codex App 顶栏添加一键快捷按钮(如启动 Dev Server、运行测试)。配置存储在项目 .codex 目录,可提交到 Git 共享给团队。
Codex App 本地环境配置
本地环境配置(Local Environments)有两个用途:
- Setup 脚本:Worktree 创建时自动运行,安装依赖或执行初始化操作
- Actions:在 Codex App 顶栏添加常用命令的快捷按钮
通过 Codex App 设置 面板配置。生成的配置文件可以提交到 Git 仓库,与团队共享。
Codex 把配置存储在项目根目录的 .codex 文件夹里。如果仓库包含多个子项目,打开包含共享 .codex 目录的那个项目目录。
Setup 脚本
Worktree 与本地任务运行在不同目录里,项目可能不完整——缺少依赖或不在 Git 里的生成文件。Setup 脚本在 Codex 创建新 Worktree 时(新线程开始时)自动运行。
用 Setup 脚本执行任何环境配置所需的命令,例如安装依赖或执行构建:
bash
npm install
npm run build如果初始化步骤因平台而异,可以为 macOS、Windows 和 Linux 分别定义 Setup 脚本,覆盖默认脚本。
Actions
Actions 定义常用任务,如启动 Dev Server 或运行测试套件。定义后,这些 Actions 会出现在 Codex App 顶栏,点击即可快速执行。Actions 在应用的集成终端里运行。
适合场景:避免反复输入构建触发命令或启动 Dev Server——把它们做成 Actions 按钮,比在集成终端手敲更快。临时的一次性调试仍然直接用集成终端。
Node.js 项目的"Run" Action 示例:
bash
npm start如果命令因平台而异,可以为 macOS、Windows 和 Linux 分别定义平台专属脚本。
每个 Action 还可以配置一个图标,方便在顶栏快速识别。
常见问题
Q: Setup 脚本和 AGENTS.md 的 Setup 有什么区别?
A: 本地环境的 Setup 脚本专门用于 Worktree 初始化(自动运行),配置文件存在 .codex 目录。AGENTS.md 里的内容是传递给 Agent 的文字指令,在每次任务时都会被读取。两者互不冲突,用途不同:前者是环境准备,后者是行为指导。
Q: 配置提交到 Git 后,团队成员会自动使用吗?
A: 是的。.codex 目录提交后,团队其他成员拉取代码就能共享同一套 Setup 脚本和 Actions 配置——在他们的 Worktree 上执行 Setup 时会运行相同的初始化命令,顶栏也会出现相同的 Actions 按钮。
Q: Worktree 创建后 Setup 脚本没有自动运行怎么排查?
A: 确认项目根目录下有 .codex 目录,且 Setup 脚本配置已保存。如果项目里有多个子目录,确保打开的是包含 .codex 的那个目录作为 Codex 项目根。