simforge package

Reference for simforge package: 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.

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
--installed-map-only		Install no map: the package’s map must already be in the cache (--cache-root), else the import fails with package_closure_unavailable. Nothing is pulled into the cache or installed from the package’s own blobs; the actor closure and sky plates are still fetched. A cloud worker’s job passes it: the worker’s parent process is the only writer of its maps cache
--registry URL		Map registry to resolve the package’s map from (https:// or file://). Default: SIMFORGE_MAPS_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

package inspect

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

package verify

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