During beta, design partners install from a private checkout or private package index. Public PyPI installation will be documented after the public package release.
2
Sync the dev environment
uv sync --extra dev
From a checkout. For an installed package, skip to the next step.
3
Confirm the install
uv run worldflux --versionuv run worldflux doctor
doctor checks Python, uv, every registered runtime plugin, and the cloud session if you are logged in.
uv run worldflux init demo-boxuv run worldflux run --project demo-boxuv run worldflux verify --project demo-boxuv run worldflux report --project demo-boxuv run worldflux visualize --project demo-box
demo-box/outputs/ now holds a manifest, metrics, logs, run history, and any artifacts the recipe produced. report.md lands in demo-box/. Nothing left the machine.
The default recipe is cpu-smoke. Pick a different one with --recipe <id>. List options with worldflux recipes list (recipes that ship: cpu-smoke, vector-control-smoke, vision-smoke, linear-world-model, mlp-world-model, mujoco-smoke, mujoco-policy-eval, dreamer-style-light, libero-pro, libero-plus).
The CLI never echoes the API key to your shell history when you use --token-env or the interactive prompt. Avoid --token <inline> outside one-off debugging.
The default --api-url is http://localhost:8000; point at a deployed cloud control plane in production. Create and list Cloud workspaces/projects in the dashboard, then use their UUIDs in the CLI. The dashboard now lists demo-box. Open it to inspect the synced run. Public share links are created from verified evidence-package artifacts, so package and verify evidence before sharing externally.
On machines with no OS keyring (some Linux containers), worldflux login fails until you pass --allow-plaintext. That writes the key to ~/.worldflux/credentials.toml. In CI, prefer --token-env and short-lived secrets over plaintext storage.
uv run worldflux init linear-box --recipe linear-world-modeluv run worldflux run --project linear-boxuv run worldflux init mlp-box --recipe mlp-world-modeluv run worldflux run --project mlp-boxuv run worldflux compare linear-box mlp-box
comparison.md lands at the repo root with metric deltas, the chosen winner, and links to whichever artifacts (prediction_plot.svg, rollout.html, rollout.mp4) the recipes produced.
uv run worldflux curated listuv run worldflux curated inspect openpiuv run worldflux use openpiuv run worldflux env build openpi # build the adapter's venvuv run worldflux curated run openpi rollout
worldflux use clones the upstream adapter into ~/.worldflux/curated/<id>/. The first call to env build resolves the adapter’s pyproject and downloads dependencies or weights required by the upstream project. curated run reuses that environment.
If you already have evaluation output, package it without rerunning the model:
uv run worldflux claim create --template openpi-libero --output claim_pkg/uv run worldflux audit import lerobot \ --from /tmp/lerobot_run_001/eval_info.json \ --output audit_input.jsonuv run worldflux audit run lerobot \ --from /tmp/lerobot_run_001/eval_info.json \ --claim claim_pkg/claim.json \ --protocol claim_pkg/protocol.json \ --output evidence_pkg/uv run worldflux evidence inspect evidence_pkg/
The package contains claim.json, protocol.json, evidence.json, provenance, and artifact metadata. Add worldflux audit sign and worldflux audit verify when reviewers need signed evidence. To create a public share that uploads sanitized evidence package bytes after Cloud login, verification, and explicit customer approval:
