// Command reference

simforge package

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

simforge package import

Verify, then unpack into a local workspace

simforge package import [OPTIONS] --into <DIR> <PACKAGE.ZIP>

Runs on: local runtime

Argument / flag	Notes	What
<package.zip>	required	The package file
--into DIR	required	The workspace directory to create (must not exist, or be empty)
--cache-root DIR		Map cache root to check for the package's map. Default: SIMFORGE_MAPS_CACHE_ROOT, then $XDG_DATA_HOME/simforge/maps
--assets-root DIR		Actor-asset root to check for the package's actor closure. Default: SIMFORGE_ACTOR_ASSETS_ROOT, then $XDG_DATA_HOME/simforge/actor-assets
--offline		Fetch nothing: report the map and actor closure this machine still lacks
--registry URL		Map registry to resolve the package's map from. Staff local builds support s3:// with AWS credentials. Default: SIMFORGE_MAPS_REGISTRY, then the staff map registry
--profile PROFILE	one of full, planar; default full	How to install a map the cache lacks: `full` (every profile) or `planar` (`maps pull --profile planar --with ground`: the road network, its planar derivatives, the static colliders and the ground, enough to simulate and render in 2D; a 3D render needs `full`). Either satisfies a planar import; only a full install satisfies a full one
--assets-base-url URL		Asset store for the actor closure. Default: SIMFORGE_ACTOR_ASSETS_BASE_URL, then the public store

Print a package's manifest, producer and members without unpacking it

simforge package inspect [OPTIONS] <PACKAGE.ZIP>

Runs on: local runtime

Argument / flag	Notes	What
<package.zip>	required	The package file

Verify the manifest and every member digest; exit 2 on any mismatch

simforge package verify [OPTIONS] <PACKAGE.ZIP>

Runs on: local runtime

Argument / flag	Notes	What
<package.zip>	required	The package file