Skip to main content

bmcli — command line tool for benchmark analysis data (metrics, trajectory, reports, artifacts).

Project description

benchloop-cli (bmcli)

Command line tool for fetching and downloading benchmark analysis data (run metrics, trajectory, pre-analysis reports, task/job lists, and artifacts) by group_id / job_id.

Install package

pip install -i http://yum.tbsite.net/aliyun-pypi/simple/ --trusted-host=yum.tbsite.net bmcli

bmcli --api-key $BENCH_LOOP_API_KEY overview get -j $JOB_ID
bmcli --api-key $BENCH_LOOP_API_KEY metrics get -j $JOB_ID

# Option 2: config ~/.benchloop/config.toml by cli, and run bmcli without --api-key option:
bmcli config set --api-key $BENCHLOOP_API_KEY --host https://benchmark-analysis.alibaba-inc.com

bmcli overview get -j $JOB_ID
bmcli metrics get -j $JOB_ID

Install and run from source

# with uv (recommended)
uv sync
uv run bmcli --help

# or editable install with pip
python -m venv .venv && source .venv/bin/activate
pip install -e .
bmcli --help

Auth & config

Authentication uses a personal api key sent as the X-API-Key header.

Precedence: CLI flag > env var > ~/.benchloop/config.toml > default.

  • Env: BENCHLOOP_API_KEY (or BENCHMARK_API_KEY), BENCHLOOP_HOST, BENCHLOOP_OUTPUT_DIR
  • Default host: https://benchmark-analysis.alibaba-inc.com
bmcli config set --api-key $BENCHLOOP_API_KEY --host https://benchmark-analysis.alibaba-inc.com

Usage

Two-segment bmcli <resource> <action> form. get prints a JSON array to stdout (pipeable to jq); download writes the standard file layout.

bmcli metrics get -j J123 | jq '.[0]'
bmcli metrics download -g G1 --scope all -o ./out
bmcli trajectory download -g G1,G2 -o ./out
bmcli report download -j J123 --agent all
bmcli jobs get -g G1 --all          # get supports --all (auto-paginate)
bmcli jobs download -g G1           # download is always full
bmcli artifacts download -g G1 -o ./out
bmcli pull -g G1 --with metrics,trajectory,jobs,artifacts -o ./out

IDs accept repeated flags, comma-separated values, and - to read from stdin. -g and -j are mutually exclusive in a single command.

Exit codes

code meaning
0 all success
1 partial failure (some ids failed)
2 usage / parameter error
3 auth failure (HTTP 401)
4 network / timeout

stdout carries data only; logs and progress go to stderr. --quiet suppresses non-error logs, --verbose adds debug logs.

Release new package

uv build
twine check dist/bmcli-0.1.6-py3-none-any.whl
twine upload -r aliyun-pypi dist/bmcli-0.1.6-py3-none-any.whl --verbose

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

benchloop_client-0.1.6-py3-none-any.whl (25.2 kB view details)

Uploaded Python 3

File details

Details for the file benchloop_client-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for benchloop_client-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 1347f95986042bc85d5c8cfdce2ebe3380d303ec21db20f95e277571ca095ae4
MD5 af8f03e270627c423fbaf127bc52bd91
BLAKE2b-256 b2b90238b576ede734ae78032646327e5dd180ba8d214727890c70f87aed8cc2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page