# @benchsdk/cli 中文文档

规范地址：https://npmcn.com/package/%40benchsdk/cli/

版本：0\.9\.1
npm 元数据更新时间：2026-10-27T17:14:55.719Z
中文译文更新时间：2026-11-07T22:02:13.694Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：282 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：1 个
- 首次发布：2026-09-08T20:41:33.484Z
- 最新版本发布：2026-10-27T17:14:55.326Z
- 近 30 天下载量：6424（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 8 个）

## 中文简介

用于查询计算SDK基准平台数据的 CLI

## 安装

```sh
npm install @benchsdk/cli
```

也可以使用：`pnpm add @benchsdk/cli`、`yarn add @benchsdk/cli`、`bun add @benchsdk/cli`

## README

# @ benchsdk/ cli (英语)

用于认证和查询计算SDK基准平台的程序CLI.

您很少需要直接安装此软件包: 它被捆绑到 `bench` 二进制运出 [`@benchsdk/runner`](https://npmcn.com/package/%40benchsdk/benchsdk-runner)。当您想要将您自己的 CLI 或脚本建在同一认证、配置和平台-query 原始字上时使用此软件包.

## 它提供的东西

-   **`run(argv)`** - 分析并发送a `bench` 引用平台命令 .
-   **`resolveAuth(override?)`** 解决基础 URL和证书 从env vars, `~/.benchsdk/config.json`,以及 `~/.benchsdk/credentials.json`。 。 。 .
-   **`createApiClient(override?)`** - 认证 `BenchmarkClient` 加已解决 `CliAuth`。 。 。 .
-   **`AuthError`** ——当找不到证书或无法刷新一个符号时抛出.

## 安装

```sh
pnpm add @benchsdk/cli
```

## 认证优先

1.  `--api-key <key>` (传至 `resolveAuth` 编号 : `createApiClient`(中文(简体) )
2.  `BENCHMARKS_PLATFORM_TOKEN`
3.  `BENCHMARKS_PLATFORM_API_KEY`
4.  保存的 OA 证书 `bench auth login` 内 `~/.benchsdk/credentials.json`

触及平台的命令至少需要一份证书.

## 配置文件

`~/.benchsdk/config.json` 存储非秘密默认值 :

```json
{
  "baseUrl": "https://platform.computesdk.com",
  "org": "computesdk",
  "format": "table"
}
```

全权证书单独存放于 `~/.benchsdk/credentials.json` 与 `0600` 权限.

## 环境变量

-   `BENCHMARKS_PLATFORM_URL` — 平台根 URL( 默认 : `https://platform.computesdk.com`(中文(简体) )
-   `BENCHMARKS_PLATFORM_API_KEY`
-   `BENCHMARKS_PLATFORM_TOKEN`

## 程序用途

```ts
import { resolveAuth, createApiClient } from '@benchsdk/cli';

const auth = await resolveAuth({ org: 'computesdk' });
const { api } = await createApiClient({ org: 'computesdk' });

const benchmarks = await api.listBenchmarks({ limit: 10 });
```

## CLI 命令

安装时 `@benchsdk/runner`,这些工具可通过 `bench` 二进制 :

-   `bench auth login` — OAuth 设备编码登录
-   `bench auth logout`
-   `bench auth status`
-   `bench org list`
-   `bench org use <slug>`
-   `bench benchmarks list [--limit N] [--offset N]`
-   `bench runs list <slug> [--limit N] [--offset N] [--participant <list>] [--since <when>] [--until <when>] [--day YYYY-MM-DD] [--tz <zone>] [--source-org <slug>]`
-   `bench runs show <slug> <runId>`
-   `bench results <slug> [--run <id>] [--format json|table] [--participant <list>] [--steps <list>|all] [--since <when>] [--until <when>] [--day YYYY-MM-DD] [--tz <zone>] [--source-org <slug>] [--limit N] [--offset N]`
-   `bench artifacts list <slug> <runId> [--worker <id>]`
-   `bench export <slug> [--run <id>] [--out <dir>]`

见 [`benchsdk-cli` 技能](https://npmcn.com/package/.agents/skills/benchsdk-cli/SKILL.md) 用于完整的CLI参考,OAuth设备-码流,以及CI/非交互使用.

## 许可证

麻省理工学院

## 常见问题

### @benchsdk/cli 是什么？

用于查询计算SDK基准平台数据的 CLI

### 如何安装 @benchsdk/cli？

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

### @benchsdk/cli 支持 TypeScript 吗？

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

### @benchsdk/cli 支持 ESM 还是 CommonJS？

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

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

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

### @benchsdk/cli 可以商用吗？

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

### @benchsdk/cli 的下载量有多少？

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

### @benchsdk/cli 还在维护吗？

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