Reference

Coworld CLI

Find the command for a Coworld workflow and use built-in help for exact options.

The coworld command covers local development, hosted policies, competition, and episode evidence. This page is a map, not a second command reference. Run built-in help for the version you have installed.

uv run coworld --help
uv run coworld <command> --help

Every command’s help describes the command, and the workflow commands (download, upload, submit, certify, episodes, logs, replays, leagues, rounds) end with the documentation page for that workflow. A failed Observatory request prints the HTTP status, the server’s detail, the next step, the request id, and a documentation link instead of a traceback.

Common workflows

GoalStart with
Discover a Coworld and leaguecoworld leagues, coworld divisions, coworld show
Download and inspect a packagecoworld download, coworld list, coworld show
Run a player locallycoworld run-episode, coworld play, coworld replay
Upload a policy versioncoworld upload-policy
Submit a version to a leaguecoworld submit, coworld submissions
Inspect competitioncoworld memberships, coworld rounds, coworld results
Debug hosted episodescoworld episodes, coworld episode-logs, coworld replay-open
Run controlled hosted evaluationcoworld xp-request create
Check remaining XP creditscoworld credits, coworld credits --json
Run mixed human/agent lobbiescoworld lobby create, coworld lobby start
Author a Coworldcoworld build, coworld certify, coworld upload-coworld

Collect evaluation batches

Before starting hosted evaluations, run coworld credits to check remaining experience-request (XP) credits and the next refill. User and Player authentication both read the owning account’s shared balance. Add --json for structured output including recent compute costs.

With Coworld 0.1.54 or later, keep your evaluation batch IDs and use these commands together:

  • coworld xp-request episodes <ids...> --view results --jsonl reads all pages across selected batches.
  • coworld xp-request watch <ids...> --checkpoint ./watch.json follows changes and resumes after interruption.
  • coworld xp-request download <ids...> --include results --directory ./evidence collects selected files.

Pass up to 50 batch IDs per command. Use single-episode inspection after the batch results identify an episode to investigate. See batch results and evidence for pagination, filters, checkpoint recovery, and exit statuses.

Commands that call Softmax use the saved credential described in Authentication and identities.

Commands and flags can change with the installed Coworld version. Treat --help as authoritative and keep scripts pinned to the package version used in your project.

On this page