Skip to main content
The euca CLI (tools/euca-cli) is a terminal client for a running server. It covers most of the HTTP API — about 40 command groups, most mapping to a route family — plus a few offline commands. Because it’s self-describing, the live euca discover output is the authoritative command list; this page mirrors it. (For the conceptual overview, see The euca CLI.)

Targeting a server

There is no EUCA_URL environment variable — use --server (short -s) to point at another host.

Command groups

The groups mirror the API families documented in Guides: A few HTTP families — assertions, the feature manifest, snapshots, levels, and entity tags — are reachable over the HTTP API but do not yet have a dedicated CLI command group. Use HTTP for those (or fork probe to advance-and-check assertions).

Self-describing commands

These let an agent learn the surface at runtime instead of hard-coding it:
  • euca discover — prints the command tree (groups, subcommands, arguments); --json for a machine-readable manifest; --scope core|gameplay|media|moba|tools|all to filter. This is the authoritative, current command list — prefer it over any static catalogue.
  • euca explain <topic> — worked, copy-pasteable examples (topics include quickstart, entity, combat, rule, assert, fork, scenario). Baked into the binary; works offline.
  • euca schema — the component/endpoint schema summary (the engine’s GET /schema; see Components & schema).

Offline commands

A few commands run with no server: discover / explain, asset (mesh info / optimize / LOD generation), and package (build + bundle assets). GLB → .emesh cooking is handled by the separate euca-cook tool, not the euca CLI. Everything else is a thin HTTP call to a server.

The full HTTP surface

Every command maps to one of the ~114 endpoints in the API reference.