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.

Setup

Pick a different name, or pass --force if you mean to overwrite the generated WorldFlux files. --force does not delete files the recipe did not create.
Install uv (curl -LsSf https://astral.sh/uv/install.sh | sh) and re-try. The docs assume uv run worldflux .... If you prefer pipx, pipx install worldflux works the same.
On macOS, Keychain handles it. On Linux without gnome-keyring or kwallet, install one or pass --allow-plaintext to fall back to a config file. Plaintext is fine on machines only you can read; in CI, prefer --token-env.

Sync

The workspace plan is at its run cap. Open Settings → Billing in the dashboard and upgrade, or wait for the cap to roll over. Stripe webhooks reconcile within a minute of checkout.
The API key is scoped to one workspace. If --workspace on login did not match the one you are syncing into, log in again with the right slug.
sync is idempotent on client_run_id. The server discards re-uploads of artifact ids it already has, so the bytes you saw twice were not double-charged.
Rotate it immediately: Settings → API keys → revoke. The CLI keyring never echoes the key. The printf + IFS= read -r -s pattern in the quickstart keeps it off your history.

Dashboard

The Overview card shows whichever workspace the sidebar has selected. Switch it from the workspace switcher and the runs appear.
Recharts reads tokens at mount time. If the page mounted before the dark theme applied, the lines are drawn in fallback colors that happen to sit on top of the surface. Reload once.

Recipes

Run uv sync --extra mujoco first. The base install does not pull MuJoCo because the wheel is large and the suite is optional.
Drop to the vjepa2_vitl 0.3B variant in the catalog, or run on a host with more memory. The catalog’s minimumVramGb is the observed floor for full-precision inference.
The two recipes wrote different metric keys into the manifest. Compare reads the union and shows n/a for missing pairs. That is intentional. It lets you compare apples to oranges and read the gap.

Privacy

Page views, click events on the primary CTAs, and a hashed user id. No run content, no API keys, no email. Opt out from Settings → Profile → Analytics opt-in.
Settings → Profile → Request export. WorldFlux Cloud queues a job and emails a download link when the bundle is ready.
Same panel: tick the confirmation box, click Schedule deletion. The account is removed on day 30. Cancel any time before then with Cancel deletion.