命令行启动

fastsim 是 FastSim 的命令行入口，提供仿真启动、配置校验与调试等常用操作。

bash

fastsim <command> [--arg value ...]
fastsim --help         # 查看所有命令
fastsim <command> --help  # 查看单个命令的参数说明

命令一览

`launch_simulation`

启动仿真。配置文件中声明的所有扩展（录制、Benchmark、HTTP Server 等）将在启动时自动 enable。

bash

# 启动仿真（仅运行仿真循环）
fastsim launch_simulation --config path/to/config.yaml

# 启动仿真并执行 task，任务结束后仿真继续运行
fastsim launch_simulation --config path/to/config.yaml --run_task

# 启动仿真并执行 task，任务结束后自动终止仿真
fastsim launch_simulation --config path/to/config.yaml --run_task --stop_sim_on_task_end

参数	说明
`--config`	配置文件路径（YAML 或 JSON）
`--run_task`	执行 task 配置中定义的任务（调用 `sim.start_with_task()`）
`--stop_sim_on_task_end`	任务结束后是否自动终止仿真，需与 `--run_task` 配合使用

`validate_configuration`

校验配置文件的合法性，包括字段类型、必填项、路径存在性与 stereotype 注册情况。

bash

fastsim validate_configuration --config path/to/config.yaml

`show_config`

将配置文件展开为完整结构并打印，包含所有默认值与继承字段。适合排查"配置写了但没生效"的问题。

bash

fastsim show_config --config path/to/config.yaml

`show_registery`

打印当前已注册的所有 stereotype（Config 类与 Model 类的映射表）。用于确认自定义 stereotype 是否被正确注册，或排查 Invalid simulator stereotype 类错误。

bash

fastsim show_registery

注意：show_registery 的结果依赖 general.scan_project 是否启用以及用户模块是否已被导入。若自定义 stereotype 未出现，检查配置中 scan_project: true 是否已设置。

`show_static_api`

打印所有通过 @apiclass 注册的 HTTP 路由列表（即启用 server 扩展后可访问的所有 REST API 端点）。

bash

fastsim show_static_api

`show_stereotype_params`

打印指定 stereotype 对应配置类的所有字段与默认值，用于快速了解某个扩展或实体类型的完整可配置参数。

bash

fastsim show_stereotype_params --stereotype_name camera
fastsim show_stereotype_params --stereotype_name record
fastsim show_stereotype_params --stereotype_name benchmark

典型工作流

bash

# 1. 校验配置，确认无误
fastsim validate_configuration --config my_config.yaml

# 2. 查看展开后的完整配置（含默认值）
fastsim show_config --config my_config.yaml

# 3. 确认 stereotype 注册表（尤其是有自定义扩展时）
fastsim show_registery

# 4. 启动仿真
fastsim launch_simulation --config my_config.yaml