CLI 参考¶
WorldForge 提供一套本地优先的命令行工具,涵盖提供方诊断、持久化的模拟世界状态、评估、基准测试、打包示例以及可选的可视化界面。所有命令均与库所使用的相同类型化 Python 接口交互。
请以 uv run worldforge --help 及各子命令的 --help 输出作为解析器的准确契约。本页是面向运维人员的稳定命令映射。
发现命令¶
贡献者环境配置及静态发布支持检查:
uv run python scripts/contributor_doctor.py --format markdown
uv run python scripts/contributor_doctor.py --format json
uv run python scripts/check_docs_commands.py
uv run python scripts/check_wrapper_portability.py
uv run python scripts/check_core_performance.py
contributor_doctor.py 将缺失的必需工具报告为配置失败,将可选运行时依赖报告为跳过,将缺失的 GitHub CLI 认证报告为发布警告而非本地验证失败。
运维故障演练:
uv run worldforge drills list
uv run worldforge drills run missing-credentials --workspace-dir .worldforge/drills
uv run worldforge drills run unsafe-event-metadata --workspace-dir .worldforge/drills --bundle
演练命令界面默认为签出安全状态。每次运行均会保存清单,记录预期的失败及恢复命令,并将生成的状态限制在所请求的临时或文档化工作区内。
提供方诊断¶
uv run worldforge doctor --registered-only
uv run worldforge provider list
uv run worldforge provider info mock
uv run worldforge provider contract mock --format json
uv run worldforge provider docs
uv run worldforge provider health mock
uv run worldforge negotiate --list
uv run worldforge negotiate --workflow policy-plus-score
当某个提供方缺失时,请优先使用 doctor 命令排查。LeWorldModel、LeRobot、GR00T 和 Cosmos-Policy 等可选提供方仅在宿主方配置了相应的环境变量和运行时后才会自动注册。worldforge negotiate 回答"在运行之前,我的提供方能否满足该工作流的需求?"这一更高层次的问题——请参阅能力协商。
预测¶
worldforge predict 会构造一个纯粹的世界状态字典,通过动作条件化的 predict 提供方推进该状态,并打印提供方名称、物理评分、置信度以及生成的世界状态 JSON。位置参数仅作为场景标签——不存在符号化的 World 运行时或本地 JSON 持久化。可通过 LatentMPCController 将 predict 与 score/policy 提供方组合,实现滚动时域规划(参见 Python API)。
评估¶
uv run worldforge eval --suite physics --provider mock
uv run worldforge eval --suite planning --provider mock --format json
内置评估套件是确定性的契约检查,适用于适配器回归测试,而非物理保真度、媒体质量或真实世界安全性的声明依据。
基准测试¶
uv run worldforge benchmark --provider mock --iterations 5 --format json
uv run worldforge benchmark --provider mock --operation embed --input-file examples/benchmark-inputs.json
uv run worldforge benchmark --provider mock --operation predict --budget-file examples/benchmark-budget.json
预算文件可使延迟、吞吐量、成功率、重试次数和错误次数超限时以非零状态码退出。在发布说明、论文或公开声明中使用数据前,请务必保存基准测试工件。
机器人案例展示 TUI¶
scripts/robotics-showcase
scripts/robotics-showcase --no-tui
uv run worldforge runs list --status failed --artifact-type json
机器人案例展示报告是可选的 Textual 驱动界面,在保持 Textual 不进入基础包的同时,可视化预制宿主上的 LeRobot 与 LeWorldModel policy+score 运行。运行历史命令无需 Textual 即可使用,并会输出脱敏的恢复信息。
预期成功信号:所选流程达到已完成的运行工作区,检查器显示其已保存的工件路径。对于 cosmos-policy,回放应报告 raw_action_shape: [50, 14]、translated_actions: 50 及 saved_replay_artifact: artifacts/cosmos-policy-replay.json。对于 gr00t-replay,预期结果为 translated_actions: 40 及 saved_replay_artifact: artifacts/gr00t-replay.json。对于 robotics-compare,预期结果为 total_translated_actions: 92 及 comparison_artifact: artifacts/robotics-policy-comparison.json。首个排查步骤:打开已保存的运行工作区,检查 logs/provider-events.jsonl 以及特定流程的工件(artifacts/cosmos-policy-replay.json、artifacts/gr00t-replay.json 或 artifacts/robotics-policy-comparison.json);如需检查实时提供方就绪状态,请运行 uv run worldforge harness --connectors --format json。
打包演示¶
签出安全演示使用注入的确定性运行时:
uv run worldforge-demo-leworldmodel
uv run worldforge-demo-lerobot
uv run --extra rerun worldforge-demo-rerun
uv run python scripts/demo_showcases.py list
uv run python scripts/demo_showcases.py run all --workspace-dir .worldforge/demo-showcases
这些演示无需安装可选模型运行时或下载检查点,即可验证 WorldForge 的提供方适配器、规划、执行、持久化、重载和事件路径。Rerun 演示需要 rerun 扩展,并将事件、世界状态、规划、三维对象框和基准测试指标记录到 .rrd 工件中。演示案例运行器保存十个由问题追踪驱动的工作流,包含 run_manifest.json、JSON 摘要、Markdown 摘要、安全的问题包以及首个排查步骤。详见演示案例工作流和用例示例手册。
可选运行时冒烟测试¶
真实 LeWorldModel 检查点打分:
LeRobot 策略加 LeWorldModel 检查点打分回放:
scripts/robotics-showcase --health-only
scripts/robotics-showcase
uvx --from "rerun-sdk>=0.24,<0.32" rerun /tmp/worldforge-robotics-showcase/real-run.rrd
不启动 Textual 报告界面,直接打开运行的 TensorBoard 日志——适用于非交互式验证或从 shell 启动 TensorBoard:
uv run worldforge-open-tensorboard --logdir .worldforge/tensorboard/<run>
uv run worldforge-open-tensorboard --logdir .worldforge/tensorboard/<run> --probe --no-browser
完整参数说明请参阅 TensorBoard 集成。
实时 GR00T 和 LeRobot 策略冒烟测试辅助工具:
uv run worldforge-smoke-cosmos-policy --help
uv run worldforge-smoke-jepa-wms --help
uv run worldforge-smoke-lerobot-leworldmodel --help
uv run python scripts/smoke_gr00t_policy.py --help
uv run python scripts/smoke_lerobot_policy.py --help
可选运行时命令需要宿主方自行提供运行时、检查点、凭证、观测数据和任务专用的动作转换器。WorldForge 不会将这些依赖添加到基础包中,也不会将注入的演示视为真实的上游推理结果。
更多详情: