# @bendyline/gezel-sdk 中文文档

规范地址：https://npmcn.com/package/%40bendyline/gezel-sdk/

版本：1\.1\.13
npm 元数据更新时间：2026-11-05T04:00:58.762Z
中文译文更新时间：2026-11-07T23:24:40.873Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：278 kB，14 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24\.0\.0
- 运行依赖：0 个
- 首次发布：2026-08-11T14:00:26.516Z
- 最新版本发布：2026-11-05T04:00:58.391Z
- 近 30 天下载量：2052（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：26（近 12 个月 26 个）

## 中文简介

SDK用于在 Gezel 沙盒中运行的脚本: gezel 对象和定义Script 帮助器.

## 安装

```sh
npm install @bendyline/gezel-sdk
```

也可以使用：`pnpm add @bendyline/gezel-sdk`、`yarn add @bendyline/gezel-sdk`、`bun add @bendyline/gezel-sdk`

## README

# @bendyline/gezel-sdk (英语)

扩展表面用于 [宝石](https://github.com/bendyline/gezel) — 已输入 写出闸口脚本,检查和自定义商店的出入口.

这是新整合的首选面. [`@bendyline/gezel-plugin-sdk`](https://www.npmjs.com/package/@bendyline/gezel-plugin-sdk) 是历史的等同物,用于兼容性.

```bash
npm install @bendyline/gezel-sdk
```

```ts
import { defineScript, gezel } from '@bendyline/gezel-sdk';

export const meta = defineScript({
  name: 'has-tests',
  description: 'Require at least one test file.',
  kind: 'gate',
  outputs: {
    decision: { type: 'string', description: "'approve' or 'reject'." },
  },
  requires: ['workspace.read'],
} as const);

const files = await gezel.fs.listAll();
gezel.output({
  decision: files.some((file) => file.includes('.test.')) ? 'approve' : 'reject',
});
```

## 入境点

| 子路径 | 目录 |
| --- | --- |
| `@bendyline/gezel-sdk` | 节点沙盒 `gezel` 上下文, `defineScript`,和脚本上下文类型 |
| `@bendyline/gezel-sdk/portable` | `createGezelSDK`, (中文(简体) ), `defineScript`,以及平台独立上下文/运输类型 |
| `@bendyline/gezel-sdk/checks` | 可重复使用的门检查原始文件 |
| `@bendyline/gezel-sdk/stores` | 为自定义后端存储接口 |

针对此 SDK 编写的脚本由 守护进程脚本跑取器 。 见 [`@bendyline/gezel-script-stdlib`](https://www.npmjs.com/package/@bendyline/gezel-script-stdlib) 用于建在它的门脚本标准库.

## 嵌入式运行时间

没有节点的主机可以为通过可移植文件运行的每个脚本创建上下文 输入。 它没有节点的进口, stdin读取, 全球单通, 或平台全球:

```ts
import { createGezelSDK, type ScriptTransport } from '@bendyline/gezel-sdk/portable';

function createScriptContext(transport: ScriptTransport) {
  return createGezelSDK(transport);
}
```

东道方用品 `transport.init` 执行脚本前,转发 `call(method, params)` 通过其经许可的调度员,交付 `notify(method, params)` 同步进行. 尚未满足的呼声必须拒绝 运行被取消或处理。 每个背景都允许 `gezel.output()` 邮票. 可选 `log` 回调镜像将日志信息切入运行时间特定的汇; `script.log` 通知总是通过运输发送.

此边界向嵌入式解释器提供 SDK API; 主机仍然 负责隔离、内存和时限、能力检查和 翻译是一个同步的工作循环. 现有桌面脚本继续导入 `gezel` 从默认条目,该条目保留 stdin初始化, fd-3 RPC, 和斯德尔伐木.

## 稳定

公众API 在semver下.

麻省理工学院

## 常见问题

### @bendyline/gezel-sdk 是什么？

SDK用于在 Gezel 沙盒中运行的脚本: gezel 对象和定义Script 帮助器\.

### 如何安装 @bendyline/gezel-sdk？

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

### @bendyline/gezel-sdk 支持 TypeScript 吗？

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

### @bendyline/gezel-sdk 支持 ESM 还是 CommonJS？

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

### @bendyline/gezel-sdk 需要什么版本的 Node\.js？

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

### @bendyline/gezel-sdk 可以商用吗？

@bendyline/gezel-sdk 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @bendyline/gezel-sdk 的下载量有多少？

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

### @bendyline/gezel-sdk 还在维护吗？

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