benchsdk-cli

bench CLI

The bench binary is the unified CLI for the ComputeSDK benchmarks platform. bench run executes benchmark files; all other commands query platform data.

Installation

The CLI ships with @benchsdk/runner. From the benchmarks repo root:

pnpm install
pnpm -r --filter "./packages/**" build

Run via the built binary:

node packages/benchsdk-runner/dist/bin.cjs --version

Or add packages/benchsdk-runner to your PATH so bench --version works.

Authentication

The CLI tries credentials in this order:

1. --api-key <key>
2. BENCHMARKS_PLATFORM_TOKEN (a better-auth session token — does not refresh)
3. BENCHMARKS_PLATFORM_API_KEY (an org-scoped bp_... key)
4. OAuth tokens from ~/.benchsdk/credentials.json (from bench auth login)

API keys and tokens are useful for non-interactive environments. OAuth is interactive and stores a refresh token under ~/.benchsdk.

Device-code login

bench auth login --base-url https://platform.computesdk.com

This prints a URL and a user code. Approve the device in the browser; the CLI polls and stores the access/refresh token pair. Access tokens last 1 hour; refresh tokens are 30-day sliding windows and rotate on every refresh.

Check status

bench auth status
bench auth status --json

Log out

bench auth logout

This removes ~/.benchsdk/credentials.json.

Configuration file

~/.benchsdk/config.json stores non-secret defaults:

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

--base-url, --org, and --format override this file. Credentials live in ~/.benchsdk/credentials.json and are created with 0600 file permissions.

Common commands

Organizations

bench org list
bench org use computesdk

bench org use switches the active organization and rewrites the stored access token with the new organization claim.

Benchmarks

bench benchmarks list
bench benchmarks list --limit 20 --offset 40
bench benchmarks list --json