# @codex-app-sdk/backend 中文文档

规范地址：https://npmcn.com/package/%40codex-app-sdk/backend/

版本：0\.23\.0
npm 元数据更新时间：2026-11-09T21:42:47.800Z
中文译文更新时间：2026-11-10T08:21:23.524Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：2.8 MB，1984 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：3 个
- 首次发布：2026-10-03T23:27:29.417Z
- 最新版本发布：2026-11-09T21:42:47.471Z
- 近 30 天下载量：7516（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：45（近 12 个月 45 个）

## 中文简介

Node.js app-server 运行时间和后端组成 Codex 应用程序.

## 安装

```sh
npm install @codex-app-sdk/backend
```

也可以使用：`pnpm add @codex-app-sdk/backend`、`yarn add @codex-app-sdk/backend`、`bun add @codex-app-sdk/backend`

## README

# `@codex-app-sdk/backend`

信任 Codex 应用程序的 Node.js 运行时间 。 它拥有应用服务器协议和 工艺寿命周期、运输、, `CodexSurface`,以及 `CodexAppBackend`。 。 。 .

```bash
npm install @codex-app-sdk/backend @codex-app-sdk/core
```

```ts
import { createCodexAppBackend } from '@codex-app-sdk/backend';

const backend = createCodexAppBackend({
  surfaceOptions: {
    clientInfo: { name: 'my_app', title: 'My App', version: '0.1.0' },
  },
});

await backend.surface.connect();
// Grant backend.surface to one trusted Electron or web adapter.
```

值得信赖的表面也暴露了用于应用自主工作流程的州中立助手: `generateText()` 运行一个只读的转弯,而 `readConversationSummary()` 财务报告和审定财务报表 `readConversationPromptHistory()` 检索 绑定的元数据或只限用户的提示历史而不给一个完整线索水分 进入制造器状态.

使用 `@codex-app-sdk/backend/protocol` 仅用于低级应用服务器方法 预测 `CodexSurface`。渲染器代码必须使用 `@codex-app-sdk/core` 加一个主机适配器,而不是导入此软件包.

后端不拥有网站用户,认证会话,业务数据, 符号存储,或进程集合策略 。 见 [运行时间 指南](https://codex-app-sdk.github.io/codex-app-sdk/guide/surface.html) 财务报告和审定财务报表 [节点 API 密码](https://codex-app-sdk.github.io/codex-app-sdk/api/node.html)生成 [JSON-RPC覆盖库存](https://codex-app-sdk.github.io/codex-app-sdk/api/json-rpc.html) 显示哪些应用服务器方法具有高水平的 SDK 投影,哪些仍然 只能通过信任的协议客户端提供.

## 常见问题

### @codex-app-sdk/backend 是什么？

Node\.js app-server 运行时间和后端组成 Codex 应用程序\.

### 如何安装 @codex-app-sdk/backend？

在项目目录运行 npm install @codex-app-sdk/backend，或使用 pnpm add / yarn add / bun add。

### @codex-app-sdk/backend 支持 TypeScript 吗？

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

### @codex-app-sdk/backend 支持 ESM 还是 CommonJS？

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

### @codex-app-sdk/backend 需要什么版本的 Node\.js？

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

### @codex-app-sdk/backend 可以商用吗？

@codex-app-sdk/backend 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @codex-app-sdk/backend 的下载量有多少？

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

### @codex-app-sdk/backend 还在维护吗？

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