Skip to main content
The euca CLI (tools/euca-cli) is a terminal client for a running server. It maps closely to the HTTP API — roughly three dozen command groups, one per route family — plus a few offline commands. Because it’s self-describing, the live euca discover output is the authoritative command list; this page is the map. (For the conceptual overview, see The euca CLI.)

​
Targeting a server

euca --server http://localhost:3917 <command>   # default: http://localhost:3917
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:
AreaGroups
Worldentity, sim, observe, tag, reset
Buildtemplate, prefab, scene, scenario, level, rule
Playgame, trigger, projectile, ai, ability, effect, item, shop, hero
Render & I/Ocamera, material, postprocess, fog, ui, animation, vfx (particles), terrain, foliage, audio, input, screenshot
Experimentfork, assert, manifest, probe, snapshot
Platformnav, script, net, asset, auth
Ops & offlinestatus, diagnose, events, profile, schema, package, discover, explain

​
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 don’t need a running server: discover / explain, asset cooking (GLB → .emesh), and packaging. Everything else is a thin HTTP call to a server.

The full HTTP surface

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