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

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

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

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

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

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

- 包体积（解压后）：156 kB，30 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：2 个
- peer 依赖：electron \>=30
- 首次发布：2026-10-06T12:47:00.393Z
- 最新版本发布：2026-11-09T21:42:39.846Z
- 近 30 天下载量：6911（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：45（近 12 个月 45 个）

## 中文简介

电能主,预装,IPC,以及用于Codex应用的本土能力适配器.

## 安装

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

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

## README

# `@codex-app-sdk/electron`

Codex应用程序的电能适配器. 它绑定一个授权的后端 表面到打入主/预装/卸载 IPC 并提供本地附件, 剪贴板 外部链接 图像预览 和 Apple 语音抄写.

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

```ts
// Electron main
import { registerCodexElectronMain } from '@codex-app-sdk/electron';

const unregister = registerCodexElectronMain({
  surface: backend.surface,
  ipcMain,
  sender: { send: (channel, payload) => window.webContents.send(channel, payload) },
  clipboard,
  dialog,
  shell,
});
```

```ts
// Preload
import { exposeCodexElectronPreload } from '@codex-app-sdk/electron/preload';

exposeCodexElectronPreload(contextBridge, ipcRenderer);
```

完整的登记拥有一个附件登记处,因此制造器安全 引用仅在信任后端前立即成为文件系统路径 电话 继续启用上下文隔离和渲染器沙箱.

见 [电能融合 指南](https://codex-app-sdk.github.io/codex-app-sdk/guide/electron.html) 财务报告和审定财务报表 [电子 API 密码](https://codex-app-sdk.github.io/codex-app-sdk/api/electron.html)。 。 。 .

## 常见问题

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

电能主,预装,IPC,以及用于Codex应用的本土能力适配器\.

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

在项目目录运行 npm install @codex-app-sdk/electron，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：electron（\>=30）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

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

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

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

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

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

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

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

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

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

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

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

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