跳到主要内容

本文为非官方中文翻译,内容以 OpenAI 官方英文文档为准。
官方来源:https://developers.openai.com/codex/app/local-environments

本地环境

为 worktree 配置常用操作和设置脚本

本地环境让你可以为 worktree 配置设置步骤,以及为项目配置常用操作。

你可以通过 Codex 应用设置 面板来配置本地环境。你可以将生成的文件提交到项目的 Git 仓库中,以便与他人共享。

Codex 将此配置存储在项目根目录下的 .codex 文件夹中。如果你的仓库包含多个项目,请打开包含共享 .codex 文件夹的项目目录。

设置脚本

由于 worktree 运行在与你的本地任务不同的目录中,你的项目可能尚未完成全部设置,并且可能缺少依赖项或未检入仓库的文件。设置脚本会在 Codex 创建新的 worktree 时、在新线程开始时自动运行。

使用此脚本来运行配置环境所需的任何命令,例如安装依赖项或运行构建流程。

例如,对于一个 TypeScript 项目,你可能希望使用设置脚本来安装依赖项并执行初始构建:

npm install
npm run build

如果你的设置依赖于平台,请为 macOS、Windows 或 Linux 定义设置脚本,以覆盖默认值。

操作

使用操作来定义常见任务,例如启动应用的开发服务器或运行测试套件。这些操作会显示在 Codex 应用顶部栏中,便于快速访问。操作将在应用的集成终端中运行。

操作有助于避免你重复输入常见命令,例如触发项目构建或启动开发服务器。对于一次性的快速调试,你可以直接使用集成终端。

Codex 应用设置中显示的项目操作列表

例如,对于一个 Node.js 项目,你可以创建一个包含以下脚本的“Run”操作:

npm start

如果操作命令依赖于平台,请为 macOS、Windows 和 Linux 定义特定于平台的脚本。

为了便于识别操作,请为每个操作选择一个关联图标。