Appearance
CLI
Use rundial to authenticate, select a project and work with runs from a terminal.
Set RUNDIAL_API_KEY to your project ingestion key before running these commands.
bash
pip install rundial
rundial target use --workspace default-workspace --project default-project
rundial run listIf a command prints No stored credentials found, set RUNDIAL_API_KEY in that shell. The list shows training runs in the selected project. Use rundial auth whoami to check access and rundial auth logout to clear stored credentials.
Profiles are stored in ~/.config/rundial/config.toml. Secrets use the system keyring when available. --allow-plaintext-store explicitly permits the fallback at ~/.config/rundial/secrets.json. Protect this file if you enable it. The default endpoint is http://127.0.0.1:8787; RUNDIAL_ENDPOINT, RUNDIAL_WORKSPACE and RUNDIAL_PROJECT can override profile settings.
Global options
Pass these before the command. Every command also accepts -h or --help.
| Option | Purpose |
|---|---|
--profile | Select a profile. |
--endpoint | Override the API endpoint. |
--format | Select output format. |
--non-interactive | Disable prompts. |
--verbose, --quiet, --no-color | Control output. |
--allow-plaintext-store | Permit local plaintext secret storage if keyring is unavailable. |
Commands
Options listed with --scope also accept --scopes; repeat them to provide multiple values. <run-id>, <name> and eval run IDs are positional arguments. Use command --help for usage.
| Command | Options and action |
|---|---|
auth | --api-key, --workspace, --project, --allow-plaintext-store: save credentials. |
auth , auth | Show the principal or clear credentials. |
auth | --workspace, --project, --scope, --agent, --label, --expires-at-ms: create a key. |
auth | --workspace, --project: list keys. |
auth | --key-id (required), --workspace, --project: revoke a key. |
auth or token | --label, --scope, --expires-at-ms, --expires-in-days, --use: create a personal token and optionally use it. |
auth | --workspace, --name (required): create an agent. |
auth | --workspace, --status : list agents. |
auth | --workspace, --agent (required): revoke an agent. |
auth | --workspace, --project, --agent (required), --scope, --label, --expires-at-ms: create an agent key. |
auth | --workspace, --agent (required): list agent keys. |
auth | --workspace, --agent, --actor-kind , --limit: list audit events. |
target | --workspace: list targets. |
target | --workspace, --project: set the default target. |
workspace | List accessible workspaces. |
project | --workspace: list projects. |
run | --workspace, --project, --name, --kind : start a run. |
run | --workspace, --project, --status, --search, --limit, --order , --order-by : list runs. --status can be repeated. |
run | --workspace, --project: inspect a run. |
run | --state , --reason, --finished-at-ms: finish a run. |
metrics | --workspace, --project, --keys, --points, --follow, --interval-seconds: print metric points. |
metrics | --workspace, --project, --keys, --format , --out (required), --start-ms, --end-ms, --page-size: export metrics. |
logs | --workspace, --project, --min-level , --text, --lines, --follow, --interval-seconds: print logs. |
logs | --workspace, --project, --format , --out (required), --start-ms, --end-ms, --page-size: export logs. |
evals | --workspace, --project, --scorer, --limit, --fail-on-regression: compare eval runs. |
profile , profile , profile | List, select or delete profiles. |
profile | --endpoint, --activate, --no-activate: create a profile. |
config | --all: show resolved configuration or all profiles. |
init | --api-key, --workspace, --project, --name, --skip-run-start, --allow-plaintext-store: set up a target and optionally start a run. |
doctor | --offline: inspect local configuration without network checks. |
doctor-capabilities | Show server CLI capabilities. |