Docs menu

// Command reference

simforge maps

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

All commands

simforge maps list

List the hosted maps your workspace can use

simforge maps list [OPTIONS]
Argument / flagNotesWhat
--limit LIMITAt most this many items
--status STATUSOnly items in this status
--type TYPEOnly items of this type

simforge maps pull

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

simforge maps pull [OPTIONS] <MAP>
Argument / flagNotesWhat
<map>requiredSimForge-owned map name, optionally pinned as NAME@VERSION
--cache-root CACHE_ROOTMap cache directory. Default: the SimForge maps cache
--accept-licenseExplicitly accept the current license and terms, which include the map pack terms, before downloading

simforge maps show

One hosted map and its versions

simforge maps show [OPTIONS] <ID>
Argument / flagNotesWhat
<id>requiredThe id