`fastsim.cli`

1 class

Command-line tools installed with the fastsim package. Run these from any terminal after installation.

class

CLI Commands

6 methods

fastsim.cli

Top-level CLI entry points provided by the fastsim package.

launch_simulationmethod

def launch_simulation(self, --config: str, --run_task: bool = False, --stop_sim_on_task_end: bool = True)

Launch the simulation from a config file, optionally running a task.

Parameters

Name	Type	Default	Description
`--config`	str	—	Path to the YAML/JSON config file.
`--run_task`opt	bool	`False`	If set, execute the configured task after initialization.
`--stop_sim_on_task_end`opt	bool	`True`	Terminate the simulation when the task finishes.

validate_configurationmethod

def validate_configuration(self, --config: str)

Validate a config file against the schema and print any errors.

Parameters

Name	Type	Default	Description
`--config`	str	—	Path to the config file to validate.

show_configmethod

def show_config(self, --config: str)

Print the fully resolved configuration to stdout.

Parameters

Name	Type	Default	Description
`--config`	str	—	Config file to load and display.

show_registerymethod

def show_registery(self)

List all registered stereotypes, extensions, and controllers.

show_static_apimethod

def show_static_api(self)

Print the static API surface exposed by all @apiclass-decorated controllers.

show_stereotype_paramsmethod

def show_stereotype_params(self, --stereotype_name: str)

Print the parameter schema for a specific stereotype.

Parameters

Name	Type	Default	Description
`--stereotype_name`	str	—	Stereotype name to inspect (e.g. 'robot', 'spawnable').