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

arena login

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: