# @bitsentry/plugin-sdk 中文文档

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

版本：0\.1\.0
npm 元数据更新时间：2026-07-05T00:03:10.694Z
中文译文更新时间：2026-11-08T04:45:34.702Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：48.1 kB，5 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-07-05T00:03:10.163Z
- 最新版本发布：2026-07-05T00:03:10.462Z
- 近 30 天下载量：5935（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 1 个）

## 中文简介

BitSentry桌面插件的SDK合同和验证计划.

## 安装

```sh
npm install @bitsentry/plugin-sdk
```

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

## README

# @ bitsentry/ plugin- sdk

BitSentry桌面插件的SDK合同和验证计划.

这个包裹是故意小的。 它定义了稳定插件边界 初始方和第三方插件编译对等,而 SuperTerminal 拥有 插件发现,安装,证书存储,执行,以及UI.

## 安装

```sh
npm install @bitsentry/plugin-sdk
```

## 使用量

```ts
import type { DesktopCodePlugin } from "@bitsentry/plugin-sdk";

export const plugin: DesktopCodePlugin = {
  id: "example",
  name: "Example",
  version: "0.1.0",
  description: "Example BitSentry desktop plugin.",
  type: "data_source",
  auth: {
    fields: [],
  },
  actions: [
    {
      id: "ping",
      title: "Ping",
      description: "Return a test response.",
      riskLevel: "read",
      fields: [],
      async execute() {
        return {
          ok: true,
          status: 200,
          summary: "Plugin executed successfully.",
          data: { pong: true },
        };
      },
    },
  ],
};

export default plugin;
```

## 合同表面

SDK导出类型Script和Zod计划用于:

-   插件描述符
-   认证和设置字段
-   插件动作
-   执行请求和结果
-   数据源设置和认证钩
-   从艺术安装请求和结果

插件应该依赖于此软件包而不是从 SuperTerminal 或 导入 `@bitsentry-ce/core`。这样可以使插件寄存器独立于 桌面应用程序的内部软件包图.

## 版本

`0.x` 在插件系统稳定时,释放可能会演变。 之后 `1.0.0`, (中文(简体) ), 打破合同的更改将需要一个大的版本起伏.

## 许可证

阿帕奇 - 2.0

## 常见问题

### @bitsentry/plugin-sdk 是什么？

BitSentry桌面插件的SDK合同和验证计划\.

### 如何安装 @bitsentry/plugin-sdk？

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

### @bitsentry/plugin-sdk 支持 TypeScript 吗？

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

### @bitsentry/plugin-sdk 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @bitsentry/plugin-sdk 可以商用吗？

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

### @bitsentry/plugin-sdk 的下载量有多少？

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

### @bitsentry/plugin-sdk 还在维护吗？

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