# @burdenoff/cli-sdk 中文文档

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

版本：2026\.1031\.2
npm 元数据更新时间：2026-10-31T16:03:04.109Z
中文译文更新时间：2026-10-31T17:36:50.312Z
软件包许可：UNLICENSED

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

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

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

- 包体积（解压后）：3.6 MB，239 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=24\.11\.0
- 运行依赖：1 个
- peer 依赖：graphql ^16\.0\.0，commander ^14\.0\.0，graphql-request ^7\.0\.0
- 首次发布：2026-05-11T04:02:55.221Z
- 最新版本发布：2026-10-31T16:03:03.922Z
- 已发布版本数：33（近 12 个月 33 个）

## 中文简介

模块化CLI SDK共享于所有Burdenoff产品CLI （vibeccontrols, botlit, fluidgrids, bigconsole, healthybowl, devportal, workspaces）。每个模块导出CliModule合约；产品cli变成了挑选要安装哪些模块的薄壳。

## 安装

```sh
npm install @burdenoff/cli-sdk
```

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

## README

# @burdenoff / cli-sdk

模块化CLI SDK在所有Burdenoff产品CLI之间共享。每个模块导出一个 `CliModule` 合同;产品cli (`vibecontrols-cli`， `botlit-cli`， `fluidgrids-cli`等)变成薄壳，选择安装哪些模块。

## 安装

```bash
bun add @burdenoff/cli-sdk commander graphql graphql-request
```

`commander`， `graphql`， `graphql-request` 是对等的深度——你的shell会直接安装它们。

## 使用

```ts
#!/usr/bin/env node
import { createProgram, buildContext } from '@burdenoff/cli-sdk/core';
import authModule from '@burdenoff/cli-sdk/modules/auth';
import vibecontrolsModule from '@burdenoff/cli-sdk/modules/vibecontrols';

const ctx = buildContext({
  productName: 'vibecontrols',
  productVersion: '1.0.0',
  defaults: {
    configDirName: 'vibecontrols-cli',
    oidcClientId: 'burdenoff_cli_vibecontrols',
    workspaceEndpointDefault: 'http://localhost:4003/workspaces/graphql',
    globalEndpointDefault: 'http://localhost:4000/global/graphql',
  },
});

const program = createProgram(ctx, [authModule, vibecontrolsModule], {
  name: 'vibecontrols',
  version: '1.0.0',
});

program.parseAsync(process.argv);
```

## 模块的合同

```ts
export interface CliModule {
  id: string;
  version: string;
  displayName: string;
  dependsOn?: readonly string[];
  register(program: Command, ctx: CLIContext): void;
  api?: (ctx: CLIContext) => unknown;
}
```

看到 `src/core/module.ts` 对于完整的类型。

## 开发

```bash
bun install
bun run sanity   # format + lint + typecheck + build + test
```

## 常见问题

### @burdenoff/cli-sdk 是什么？

模块化CLI SDK共享于所有Burdenoff产品CLI （vibeccontrols, botlit, fluidgrids, bigconsole, healthybowl, devportal, workspaces）。每个模块导出CliModule合约；产品cli变成了挑选要安装哪些模块的薄壳。

### 如何安装 @burdenoff/cli-sdk？

在项目目录运行 npm install @burdenoff/cli-sdk，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：graphql（^16\.0\.0）、commander（^14\.0\.0）、graphql-request（^7\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @burdenoff/cli-sdk 支持 TypeScript 吗？

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

### @burdenoff/cli-sdk 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

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

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

### @burdenoff/cli-sdk 可以商用吗？

@burdenoff/cli-sdk 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### @burdenoff/cli-sdk 还在维护吗？

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