# @gapi/cli-builder 中文文档

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

版本：1\.8\.263
npm 元数据更新时间：2026-11-15T16:23:35.135Z
中文译文更新时间：2026-11-15T23:07:52.885Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：237 kB，81 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：7 个
- 首次发布：2020-04-18T08:55:47.458Z
- 最新版本发布：2026-11-15T16:23:34.977Z
- 近 30 天下载量：3802（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：231（近 12 个月 116 个）

## 中文简介

`bash $ npm install @gapi/cli-builer`

## 安装

```sh
npm install @gapi/cli-builder
```

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

## README

# @ Gapi Graphql CLI 构建器

## 安装 :

```bash
$ npm install @gapi/cli-builer
```

```ts
import {
  CLIBuilder,
  Environment,
  GenericEnum,
  Bootstrap,
  executeCommand,
  SpawnOptionsWithoutStdio,
} from '@gapi/cli-builder';

export const Git = (
  args: string[] = [],
  options?: SpawnOptionsWithoutStdio
) => executeCommand('git', args, options);

export enum Commands {
  GIT = 1,
}

Bootstrap(
  CLIBuilder.forRoot<typeof Commands>(
    {
      GIT: async (args: string[]) => {
        console.log('[RUN_GIT]: started arguments: ', args);
        const data = await Git(args);
        console.log('[RUN_GIT]: exited');
        return data;
      },
    },
    Commands
  )
).subscribe(() => {
  if (Environment.GRAPHQL_RUNNER_SUBSCRIPTION_URI) {
    console.log(
      'STARTED_SUBSCRIPTIONS:',
      Environment.GRAPHQL_RUNNER_SUBSCRIPTION_URI
    );
  } else {
    console.log(
      'SIGNAL_MAIN_API_STARTED',
      `Running at http://localhost:${Environment.GRAPHQL_RUNNER_API_PORT}`
    );
  }
});
```

开放http://localhost:42043 ' 执行图克l查询

```graphql
mutation {
  execute(cmd: GIT, args: ["status"]) {
    code
    data
    error
  }
}
```

订阅其他主题

```graphql
mutation subscribeToGraphqlPubsub {
  subscribeToGraphqlPubsub(
    uri: "ws://localhost:9000/subscriptions"
    worker_type: "runner"
  ) {
    code
    data
    error
  }
}

mutation unsubscribeToGraphqlPubsub {
  unsubscribeToGraphqlPubsub {
    code
    data
    error
  }
}
```

## 常见问题

### @gapi/cli-builder 是什么？

bash $ npm install @gapi/cli-builer

### 如何安装 @gapi/cli-builder？

在项目目录运行 npm install @gapi/cli-builder，或使用 pnpm add / yarn add / bun add。

### @gapi/cli-builder 支持 TypeScript 吗？

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

### @gapi/cli-builder 支持 ESM 还是 CommonJS？

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

### @gapi/cli-builder 可以商用吗？

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

### @gapi/cli-builder 的下载量有多少？

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

### @gapi/cli-builder 还在维护吗？

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

