Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.worldflux.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Install

1

Install uv

curl -LsSf https://astral.sh/uv/install.sh | sh
The CLI ships as a Python package. uv is the runner the docs use; pipx install worldflux works too.
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 --version
uv run worldflux doctor
doctor checks Python, uv, every registered runtime plugin, and the cloud session if you are logged in.

​
First local run

uv run worldflux init demo-box
uv run worldflux run --project demo-box
uv run worldflux verify --project demo-box
uv run worldflux report --project demo-box
uv run worldflux visualize --project demo-box
demo-box/outputs/ now holds a manifest, metrics, logs, 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, linear-world-model, mlp-world-model, mujoco-smoke, mujoco-policy-eval, dreamer-style-light).

​
Sync to the cloud

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.
printf "Paste WorldFlux API key: "
IFS= read -r -s WORLDFLUX_TOKEN
echo
export WORLDFLUX_TOKEN

uv run worldflux login \
  --api-url http://localhost:8000 \
  --token-env WORLDFLUX_TOKEN \
  --workspace research-eval \
  --project demo-box

unset WORLDFLUX_TOKEN
uv run worldflux sync --project demo-box
The default --api-url is http://localhost:8000; point at a deployed cloud control plane in production. The dashboard now lists demo-box. Open it, copy the share link, send it to whoever asked.
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.

​
Compare two runs

uv run worldflux init linear-box --recipe linear-world-model
uv run worldflux run --project linear-box

uv run worldflux init mlp-box --recipe mlp-world-model
uv run worldflux run --project mlp-box

uv 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.

​
Curated adapters

uv run worldflux curated list
uv run worldflux curated inspect openpi
uv run worldflux env build openpi          # build the adapter's venv
uv run worldflux curated run openpi --task rollout
The first call to env build resolves the adapter’s pyproject and downloads weights. curated run reuses that environment.

​
Where to go next

CLI reference

Every top-level command and sub-tree, with --json examples for CI.

Dashboard

Sidebar, runs, compare, public share, billing.

Concepts

BYO model, runtime plugins, eval bridges.

FAQ

Edge cases, error messages, common slips.