@ benchsdk/ cli (英语)

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

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

它提供的东西

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

安装

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 存储非秘密默认值 :

{
  "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

程序用途

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 技能 用于完整的CLI参考,OAuth设备-码流,以及CI/非交互使用.

许可证

麻省理工学院