CLI commands¶
Commands listed here are the ones Arena shows in the UI (Profile and Agents deployment snippets). Install the Python CLI package first, then authenticate with Authentication.
Authentication¶
Command |
Shown on |
|---|---|
|
Profile (alternative to a PAT) |
arena login
Run once per machine (or again after session expiry). The arena agent generate snippet assumes you are already authenticated.
Set ARENA_API_KEY instead when you cannot open a browser. Profile does not print a separate arena subcommand for keys; create the PAT in the UI and export the variable.
Inference¶
The Arena CLI tab appears under Deployment code only for LLM deployments, after status is Deployed. It shows a single arena agent generate command:
arena agent generate YOUR_DEPLOYMENT_NAME --prompt "Your prompt here"
YOUR_DEPLOYMENT_NAME: deployment name from the Agents list (same string as in the Arena client tab).--prompt: the text you send. The command streams the completion to your terminal.
Authenticate first with arena login or ARENA_API_KEY (see Authentication).
Classic RL and supervised deployments¶
Gym, PettingZoo, recurrent PPO, and supervised (predict) deployments do not show an Arena CLI tab. Use the Arena client tab (ArenaClient + open_inference_agent) for a rollout loop, or wire Manual HTTP yourself.
Projects, experiments, environments¶
The Arena web app does not currently show terminal commands for creating projects, submitting training jobs, or uploading custom environments. Do that work in the UI:
Datasets¶
The web app does not show a terminal snippet for creating datasets. Language and tabular datasets (reasoning, preference, SFT, and tabular) can be created from a local CSV or Parquet file, or from a Hugging Face layout folder of parquet files (multiple file parts with relative names such as main/train-00000-of-00001.parquet). Send optional form field config when the folder has more than one config (for example gsm8k main vs socratic). Parquet is accepted when the file name ends in .parquet, the content type is application/vnd.apache.parquet or application/parquet, or the bytes start with the PAR1 magic. The 1 GB limit applies to the whole request body (all shards together). Invalid parquet fails. Non-tabular local files still require the web UI.