# @fieldwork-ai/codex-transport 中文文档

规范地址：https://npmcn.com/package/%40fieldwork-ai/codex-transport/

版本：0\.1\.11
npm 元数据更新时间：2026-11-09T11:35:58.632Z
中文译文更新时间：2026-11-15T17:27:45.682Z
软件包许可：\(MIT OR Apache-2\.0\) AND Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40fieldwork-ai/codex-transport
原文对照：https://npmcn.com/package/%40fieldwork-ai/codex-transport/?lang=original
项目主页：https://github.com/fieldwork-ai/fieldwork-code#readme
源码仓库：https://github.com/fieldwork-ai/fieldwork-code

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：114 kB，28 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：2 个
- 首次发布：2026-09-07T11:58:15.673Z
- 最新版本发布：2026-11-09T11:35:58.372Z
- 近 30 天下载量：2028（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 12 个）

## 中文简介

从OpenAI Codex移植的AI SDK的ChatGPT订阅传输和OAuth.

## 安装

```sh
npm install @fieldwork-ai/codex-transport
```

也可以使用：`pnpm add @fieldwork-ai/codex-transport`、`yarn add @fieldwork-ai/codex-transport`、`bun add @fieldwork-ai/codex-transport`

## README

# @ fieldwork-ai/ codex- transport

AI SDK 的 ChatGPT 订阅传输 `LanguageModelV4`,带有设备代码和浏览器的 PKCE OAuth, 备忘读取并刷新租赁。 协议行为从 [OpenAI 代码](https://github.com/openai/codex),在Apache -2.0的下方. 已锁定的上游修订和源路径 `NOTICE`。 。 。 .

需要节点24。 安装方式 `pnpm add @fieldwork-ai/codex-transport`。 。 。 .

```ts
import { createOpenAISubscriptionModel } from '@fieldwork-ai/codex-transport';

const model = createOpenAISubscriptionModel({
  modelId: 'gpt-5.6-luna',
  accessToken: credential.accessToken,
  accountId: credential.accountId,
  attribution: { originator: 'your-app', userAgent: 'your-app/1.0' },
});
```

把模型传给AI SDK的 `generateText` 或者说 `streamText`. 订阅全权证书属于使用客户端的个人。 此软件包不存储证书或提供共享代理 。 每个网络进入点都需要呼叫者归属;它从来不会假装是Codex CLI.

`createOpenAISubscriptionModel` 将项目信息输入可移植上下文并使用 `CodexClient.complete` 编号 : `stream`。客户端遵循 Codex 回复请求合同:账户和归属头,会话和线程头,模型/层次路由,加密推理重放, `store: false`压缩。 SSE 是默认,包括 `transport: 'auto'`; 明确 `transport: 'websocket'` 使用同一事件解码器在 Response WebSockets 上。 请求可以用 SDK 中止 `abortSignal`编辑 `provider` 身份遗存 `openai-subscription`,包括由更早的客户端保存的推理元数据.

可选客户端设置是 `fedramp`, (中文(简体) ), `responsesLite`, (中文(简体) ), `compression`, (中文(简体) ), `baseUrl`,以及 `fetchFn`. 响应-升出平稳的每行码前缀标识,将工具放入 `additional_tools` 条目,并将指令移动到输入中。 这是选入。 这里没有对话历史或工具执行循环.

图像默认为 PNG、 JPEG、 GIF 和 WebP; 呼叫者可以用 `isModelImageMime`。不支持的文件、外国推理和供应商特定内容在不丢弃存储的对话的情况下降解。 投影时从未获取 URL .

用于 OAuth, 使用 `requestOpenAIDeviceAuthorization`, (中文(简体) ), `pollOpenAIDeviceAuthorization`,以及 `exchangeOpenAIDeviceAuthorization`,或 `loginOpenAISubscriptionDeviceCode` 整个投票流程。 浏览器客户端使用 `beginOpenAIBrowserAuthorization` 财务报告和审定财务报表 `exchangeOpenAIBrowserAuthorization`;呼叫者拥有收听器 `http://localhost:1455/auth/callback` 并安全保留返回的 PKCE 验证器和状态直至交换。 OAuth呼叫验证回调状态,约束目的地,绑定响应机构,以及编辑提供者出错.

`refreshWithCredentialLease` 坐标刷新到 `OpenAISubscriptionRefreshStore`· ; `InMemoryOpenAISubscriptionRefreshStore` 提供。 执行基于数据库的呼叫者 `read`, (中文(简体) ), `tryAcquire`, (中文(简体) ), `commit`,以及 `release`,强制执行生成和租赁所有权。 加密应用程序存储的持久证书 .

`fetchCodexUsage` 返回常态化使用窗口. `isOpenAISubscriptionUsageLimitError` 承认服务的备抵错误代码。 API都没有要求应用程序的数据库或计费模型.

## 发展

从寄存器根运行 `pnpm install --frozen-lockfile`, (中文(简体) ), `pnpm build`,以及 `pnpm test`。这个软件包生活在 `packages/codex-transport` 并且独立于CLI发布. 测试包括消息投影、OAuth、同时刷新、使用正常化、SSE解码、请求信头/压缩以及认证的WebSockets。 首先通过发布此寄存器发布;消费者必须给已发布的版本打上针,而不是本地路径或补丁依赖.

## 许可证

现场工作 AI代码是在麻省理工学院或Apache-2.0下双许可的,由你选择. 由OpenAI衍生的Codex运输部分保留了Apache-2.0术语和归属。 见LICENSE,LICENSE-MIT,LICENSE-APACHE,以及运输通知。 属地保留自己的许可证。 软件包元数据 `(MIT OR Apache-2.0) AND Apache-2.0` 记录外地工作贡献的选择和所需的上游条件.

## 常见问题

### @fieldwork-ai/codex-transport 是什么？

从OpenAI Codex移植的AI SDK的ChatGPT订阅传输和OAuth\.

### 如何安装 @fieldwork-ai/codex-transport？

在项目目录运行 npm install @fieldwork-ai/codex-transport，或使用 pnpm add / yarn add / bun add。

### @fieldwork-ai/codex-transport 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @fieldwork-ai/codex-transport 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @fieldwork-ai/codex-transport 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @fieldwork-ai/codex-transport 可以商用吗？

@fieldwork-ai/codex-transport 使用 \(MIT OR Apache-2\.0\) AND Apache-2\.0 许可。可在 MIT、Apache-2\.0\) AND Apache-2\.0 中任选其一遵守。选择 MIT 时，宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @fieldwork-ai/codex-transport 的下载量有多少？

根据 npm 官方下载统计，@fieldwork-ai/codex-transport 在 2026/10/15 – 2026/11/13 这 30 天内被下载 2,028 次，日均约 68 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @fieldwork-ai/codex-transport 还在维护吗？

最新版本 0\.1\.11 发布于 2026/11/09（6 天前）；至今共发布 12 个版本，其中过去 12 个月发布了 12 个；首次发布于 2026/09/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。