Skip to content

auth.md

Latest commit

 

History

History
71 lines (51 loc) · 2.05 KB

auth.md

File metadata and controls

71 lines (51 loc) · 2.05 KB
Raw

(cli-auth)=

auth - Hosted Submission Credentials

Manage the token used by benchbox submit --service.

Tokens are stored in the operating system keyring through the Python keyring package. They are not written to BenchBox config files. For automation, BENCHBOX_SUBMIT_TOKEN takes precedence over BENCHBOX_SERVICE_TOKEN, and both environment variables take precedence over the keyring.

Basic Syntax

uv run -- benchbox auth COMMAND [OPTIONS]

Commands

Command Description
login Store a hosted results token in the OS keyring
status Show whether a token is available for a service URL
refresh Replace the stored keyring token
logout Remove the stored keyring token

Examples

# Prompt for a token and store it securely
uv run -- benchbox auth login

# Store a token for a staging service
uv run -- benchbox auth login --service https://staging.benchbox.dev/v1

# Check whether BenchBox can submit to the default service
uv run -- benchbox auth status

# Replace a stored token
uv run -- benchbox auth refresh

# Remove a stored token
uv run -- benchbox auth logout

Prefer the prompt or an environment variable for secrets. benchbox auth login --token ... exists for controlled automation, but command-line token values can be captured by shell history and process listings on some systems.

Environment Tokens

For CI or ephemeral environments:

export BENCHBOX_SUBMIT_TOKEN=...
uv run -- benchbox submit --last --service

BENCHBOX_SUBMIT_TOKEN is the primary hosted submission variable. BENCHBOX_SERVICE_TOKEN remains supported as a fallback for older automation. Environment tokens are never saved by BenchBox. If an environment token is active, uv run -- benchbox auth refresh asks you to update or unset that environment variable instead of hiding a replacement keyring token behind it.

Related

  • submit - Upload or package benchmark results
  • results - Show hosted submission history