OpenAI Codex 中文文档(4.14更新)
联系我
官方文档

本地环境

为工作树配置初始化脚本和项目常用动作

本地环境让你为工作树配置初始化步骤,也可以为项目定义一组常用动作。

你可以在 Codex App 设置 中配置本地环境。生成出的配置文件可以提交到项目的 Git 仓库里,供团队共享。

Codex 会把这份配置存放在项目根目录下的 .codex 文件夹中。如果你的仓库里包含多个项目,请打开那个包含共享 .codex 文件夹的项目目录。

初始化脚本

由于工作树运行在与本地任务不同的目录里,项目可能还没有完成初始化,也可能缺少那些未提交到仓库中的依赖或文件。每当你新开一个线程、Codex 创建新工作树时,初始化脚本都会自动运行。

你可以在这里放入任何用于准备环境的命令,例如安装依赖或执行一次初始构建。

例如,对一个 TypeScript 项目,你可能希望通过初始化脚本安装依赖并执行首次构建:

npm install
npm run build

如果初始化逻辑依赖平台差异,你可以分别为 macOS、Windows 和 Linux 提供覆盖默认值的初始化脚本。

常用动作

你可以用常用动作(actions)定义一些高频任务,例如启动开发服务器或运行测试。这些动作(action)会显示在 Codex App 顶部栏里,便于快速触发。它们会在应用的集成终端中运行。

动作的意义在于减少反复输入那些常见命令,比如触发一次构建或启动项目的开发服务器。如果只是临时调试,也可以直接使用集成终端。

Codex App 设置中展示的项目动作列表

Codex App 设置中展示的项目动作列表

例如,对于一个 Node.js 项目,你可以创建一个名为 “Run” 的动作,其中脚本内容如下:

npm start

如果动作中的命令依赖平台差异,也可以分别为 macOS、Windows 和 Linux 定义平台专属脚本。

为了便于识别,给每个动作选择一个对应的图标。


来源:https://developers.openai.com/codex/app/local-environments