@ever-works/codex-plugin (英语)
将生成工作委托给 代码 CLI。一个单独的 Codex 会话研究、创建和更新临时工作空间内的工作项目JSON文件.
插件元数据
| 外地 | 数值 |
|---|---|
| 身份证 | codex |
| 类别 | pipeline |
| 能力 | pipeline, (中文(简体) ), form-schema-provider, (中文(简体) ), device-auth |
| 作者 | 永远工作团队 |
| 许可证 | AGPL-3.0 导弹 |
| 内建 | 对 |
| 可自动启用 | 没有 |
管道步骤
该插件运行了6个相继步骤 :
| {\fn方正粗倩简体\fs12\an8\1cHFFFF00\b0} | 步骤 | 说明 | 可选 |
|---|---|---|---|
| 1个 | 设置代码x | 下载/检查 Codex CLI 二进制并解析认证 | 没有 |
| 2个 | 准备背景 | 创建临时工作空间、种子现有项目和元数据 | 没有 |
| 3个 | 生成项目 | 执行 Codex CLI 作为 JSON 文件进行研究和生成项目 | 没有 |
| 页:1 | 收集结果 | 读取生成的 JSON 文件返回到管道结果 | 没有 |
| 页:1 | 抓取屏幕截图 | 对生成的项目进行截图( 通过截图提供者) | 对 |
| 6个 | 清理 | 删除临时工作空间 | 对 |
步骤3,a 分类学观察者 监视新项目文件的工作空间并保存 _meta/ 实时同步分类文件(类别,标签,品牌). 按项目报告进展情况.
认证
Codex支持两个认证模式:
API 密钥
在插件设置中提供 OpenAI API 密钥( O)apiKey 页:1.
从一个 平台.openai.com/账户/api键。 。 。 .
本地编码 Auth
如果没有配置 API 密钥, 插件可以使用存储在一个管理的每个用户的本地 Codex CLI 认证 CODEX_HOME通过登入向导或手动认证:
codex login
插件实现一个孤立 CODEX_HOME 用于每个 Ever Works 用户在其管理下的临时工作,所以本地 Codex 认证不依赖共享 ~/.codex/auth.json。 。 。 .
登入UI提供3步流程:选择认证模式,配置证书,并验证连接.
设置
| 设置 | 类型 | 范围 | 说明 |
|---|---|---|---|
authMode | 字符串 | 用户 | api-key 或者说 local (隐藏,由登机法师设置) |
apiKey | 字符串 | 用户 | OpenAI API 密钥( 机密, 支持 env var) OPENAI_API_KEY(中文(简体) ) |
model | 字符串 | 全球 | 生成模型( 默认 ): gpt-5.4(中文(简体) ) |
unsafeBypassSandbox | 布尔 | 隐藏 | 在不兼容的主机上进行旁通编码沙箱 |
支持的模式
- GPT-5.4 (韩语) (默认) - 400k 上下文
- 最新代码 - 200公里背景
- GPT-5.2 编码 - 400k背景
表单Schema
插件提供了一个用户格式,有两个可配置字段:
| 外地 | 类型 | 默认 | 验证 | 说明 |
|---|---|---|---|---|
target_items | 编号 | 第50条 | 1 -500 (中文(简体) ) | 要生成的新项目的目标数量 |
capture_screenshots | 布尔 | 虚假 | - 说吧 | 获取生成项目的截图 |
提示系统
提示通过一个即时外观(如:Langfuse)来管理. 当找不到外部提示时,硬码默认被作为倒置.
提示键 :
codex.system- 系统即时模板codex.user- 用户提示模板
两者都支持工作环境、现有项目、类别、标签和品牌的可变替代.
二进制管理
插件会自动下载并缓存 Codex CLI 二进制 :
- 二进制被缓存于
/tmp/codex-generator/bin/ - 支持 Linux (x64/arm64) 和 macOS (x64/arm64)
- 回到系统安装
codex如果下载失败则命令 - 默认 CLI 版本 :
0.120.0
处理错误
- 非零退出代码:作为软警告处理. 如果物品仍在生产中,结果就会成功,并附有警告.
- 沙盒写块:被探测和记录,但 永远 单靠沙盒绕道再试. 探测器读取了 Codex 的 stdout/stderr,这是模型出产的文本,可以注入内容(取出一页,README),因此不能允许它升级为
--dangerously-bypass-approvals-and-sandbox。旁通只有在操作员明确允许时才会发生unsafeBypassSandbox(然后每跑一次都绕开) 见 沙盒绕行。 。 。 . - 结构化产出回收: 如果 Codex 不写入项目文件而完成, 插件尝试使用二次通过
--output-schema财务报告和审定财务报表--output-last-message以恢复结构化输出. - 隐蔽的秘密编号:
getRealSecret帮助过滤出 UI 占位符值( E)••••在使用全权证书之前.
项目结构
src/
codex.plugin.ts # Main plugin class (IPlugin, IPipelinePlugin, IFormSchemaProvider, ILocalAuthProvider)
types.ts # Step IDs, constants
steps.ts # Pipeline step definitions
form-schema.ts # Form fields, groups, validation
prompt-keys.ts # Prompt facade keys
device-auth.ts # Device auth flow (codex login --device-auth)
index.ts # Public exports
prompt/
system-prompt.ts # Default prompts and variable builders
utils/
binary-manager.ts # CLI binary download and caching
pipeline-helpers.ts # State management, auth resolution, progress reporting
process-runner.ts # Codex CLI subprocess execution
workspace-manager.ts # Workspace I/O (create, seed, read, cleanup)
screenshot-capture.ts # Screenshot facade integration
taxonomy-sync.ts # Merge new categories/tags/brands into _meta files
taxonomy-watcher.ts # Filesystem watcher for live taxonomy sync
platform.ts # Platform detection helpers
subprocess-env.ts # Environment variable setup for subprocesses
scripts/
smoke-codex.mjs # Manual smoke test script
发展
# Build
pnpm build
# Type-check
pnpm type-check
# Run tests
pnpm test
# Watch mode
pnpm test:watch
# Coverage
pnpm test:coverage
沙盒绕行
除非另有说明 否则Codex会运行在它自己的沙盒里 两条路可以运行它
--dangerously-bypass-approvals-and-sandbox (完全主机访问,不批准):
- 生成管道 - 只有在操作员设定时
unsafeBypassSandbox: true(隐藏设置,默认)false) (中文(简体) ). 当 Codex 输出时, 插件不再自动升级 说 写入被屏蔽: 该输出 即时输入的模型可以准确打印这些短语。 下降的升级记录为: 警告; 结构化输出回收仍在进行, 有沙箱. - 代码编辑路径 (单位:千美元)
executeCodeEdit(b) —— 永远 今天通过绕行旗。 它编辑一个工作空间 用于运行的平台需要不受限制的写作。 将任何主机运行代码编辑视为给定 codex 处理插件本身的 OS 权限: 在没有证书或网络的容器/ VM 中运行 不应该到达。 这种行为没有改变,这里有记载,因此是一种众所周知的、经过审查的权衡.
烟雾测试
本地验证真实的 Codex CLI 集成 :
pnpm smoke
对于需要沙盒绕行的主机:
CODEX_SMOKE_BYPASS_SANDBOX=1 pnpm smoke
无论是要求 OPENAI_API_KEY 环境或本地编码文件认证(codex login) (中文(简体) ).
解决问题
| 症状 | 可能的原因是 | 修补 |
|---|---|---|
世代从不开始/留在 0% | codex 未选择此工程的运行中的管道插件 | 打开工作 插件 → pipeline 能力和设置 codex 作为活动管道;或 设置为全球管道默认 设置 — 插件 |
步骤失败 No AI / search / screenshot provider configured | 管道依赖于无法启用或没有证书的能力插件 | 启用并配置工作或全球匹配能力插件( AI 提供者、 搜索、 截图、 内容提取器) |
| 步骤输出看起来错误/ 通用 | Form-field 调制未设置; 使用与工程域不符的默认管道 | 打开 生成表单 为工作设置特定域(类别、目标关键词、源 URL),并重运行受影响的步骤 |
子进程错误 : command not found | Codex Generator 运行 API 主机上未安装 CLI | 在 API 主机上安装 Codex 生成器 CLI, 并确保它打开 PATH; 通过运行验证 which <cli> 发射的同一枚炮弹 pnpm dev:api |
| 认证 / 设备- 自动流动站 | 上游 IDE / 浏览器中从未确认设备自动代码 | 重运行设备自动流出 设置 – 插件 – 代码 – 连接,然后在代码到期前在上游服务中填写提示 |
| 主机重启后管道无法恢复 | 检查站没有继续存在(今天只有标准管道维持检查站) | 取消被卡住的运行并重新触发生成; 因为生产可靠性更可取 standard-pipeline |
文档
许可证
AGPL-3.0 导弹