simforge vehicle

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

vehicle import

Validate a .glb here, upload it and store it as the workspace’s own workspace.<id> (private to the workspace); the licence and attribution travel with every render

simforge vehicle import [OPTIONS] --id <ID> --license <SPDX> --attribution <TEXT> <MODEL.GLB>

Argument / flag	Notes	What
<model.glb>	required	The model, a binary glTF (.glb)
--id ID	required	Its id within the workspace: scenarios bind it as workspace.<id> (lowercase letters, digits, _, -; at most 48)
--license SPDX	required	Its licence: an SPDX id (CC-BY-4.0) or LicenseRef-<name> with —license-text
--license-text FILE		The licence’s text, for a LicenseRef-* licence
--attribution TEXT	required	The credit the licence asks for (author, title, link)
--source TEXT		Where the model came from (URL or text)
--name TEXT		Its display name. Default: the id
--class CLASS	default car	The road-vehicle class it drives as: car, van, truck or bus
--dims L,W,H		Its real length, width and height in metres; the model must match within 10%

vehicle list

The vehicles a scenario can bind by catalogId: the shared catalog’s and, signed in, the workspace’s own (workspace.<id>)

simforge vehicle list [OPTIONS]

vehicle validate

Check a .glb against the vehicle model contract (frame, size, wheel and body nodes, triangle budget, materials, textures); exit 2 on any error

simforge vehicle validate [OPTIONS] <MODEL.GLB>

Argument / flag	Notes	What
<model.glb>	required	The model, a binary glTF (.glb)
--class CLASS	default car	The road-vehicle class it will drive as: car, van, truck or bus (sets the plausible size)
--dims L,W,H		Its real length, width and height in metres (4.6,1.85,1.45); the model must match within 10%