simforge maps

Reference for simforge maps: usage, arguments and flags, generated from the CLI.

Generated from the CLI’s own help (CLI 0.2.0-rc.5). Global flags and exit codes are on the command reference.

maps list

List the hosted maps your workspace can use (signed out: the public catalogue), each with the packs maps pull installs (packs: variant, version, download and installed bytes) and what is installed locally (installed: 2d, 3d or null)

simforge maps list [OPTIONS]

Argument / flag	Notes	What
--limit LIMIT	default 20	At most this many items on the page
--cursor CURSOR		The next page: the nextCursor of the page before it

maps pull

Download a map your signed-in account is entitled to into the local cache, sha256-verified

simforge maps pull [OPTIONS] <MAP>

Argument / flag	Notes	What
<map>	required	SimForge-owned map name, optionally pinned as NAME@VERSION
--for LEVEL	one of 2d, 3d	What to install the map for: 2d (authoring, simulation and 2D renders: a few MB) or 3d (also local 3D renders; the whole map, GB). Default: 3d when this map is already installed for 3D, else 2d. Cloud renders (--cloud) need neither
--cache-root CACHE_ROOT		Map cache directory. Default: the SimForge maps cache
--accept-license		Explicitly accept the current license and terms, which include the map pack terms, before downloading

maps show

One hosted map (signed out: a public one), with its packs’ sizes and what is installed locally

simforge maps show [OPTIONS] <ID>

Argument / flag	Notes	What
<id>	required	The id

maps status

The maps installed in the local cache and what each is installed for (2d or 3d). Reads no network

simforge maps status [OPTIONS] [MAP]

Argument / flag	Notes	What
<map>		Only this map
--cache-root CACHE_ROOT		Map cache directory. Default: the SimForge maps cache