# WorldFlux

> WorldFlux documentation — CLI, cloud API, dashboard, runtime plugins, eval bridges, and the design system.

## Docs

- [CLI reference](https://docs.worldflux.ai/docs-site/cli/reference.md): The Typer-based worldflux CLI. Top-level commands plus the recipes / runs / datasets / curated / installed / env / runtime / cloud sub-trees.
- [Cloud API reference](https://docs.worldflux.ai/docs-site/cloud/api-reference.md): WorldFlux Cloud is a FastAPI service. The Next.js dashboard ships a thin BFF that proxies authenticated calls. The OpenAPI document is the source of truth.
- [Bring your own model](https://docs.worldflux.ai/docs-site/concepts/byo-model.md): WorldFlux records the runs you already do. It does not host GPUs, train models, or borrow your weights.
- [Curated catalog](https://docs.worldflux.ai/docs-site/concepts/curated-catalog.md): Ten world-model adapters that ship with WorldFlux. Each entry names its provider, runtime, benchmark, VRAM floor, and known issues.
- [Eval bridges](https://docs.worldflux.ai/docs-site/concepts/eval-bridges.md): An eval bridge maps a third-party benchmark suite into the WorldFlux manifest. Four ship by default: cosmos, libero, minecraft, vjepa.
- [Runtime plugins](https://docs.worldflux.ai/docs-site/concepts/runtime-plugins.md): A runtime plugin tells the CLI how to launch an adapter. Four ship by default — local, modal, aws-ec2, replicate. The Protocol is small and the dispatcher does the rest.
- [Dashboard](https://docs.worldflux.ai/docs-site/dashboard.md): A read-then-act surface. The CLI mutates. The dashboard reflects, exposes a few targeted actions (keys, members, share links, billing), and stops there.
- [Design system](https://docs.worldflux.ai/docs-site/design/system.md): WorldFlux uses Resend's obsidian register: pure black canvas, hairline graphite borders, outlined Electric Blue CTA, six status colors locked to product data.
- [FAQ](https://docs.worldflux.ai/docs-site/faq.md): Edge cases, error messages, and the questions people email about most often.
- [Introduction](https://docs.worldflux.ai/docs-site/introduction.md): WorldFlux is a control plane for world-model runs. Compute stays on your hardware. The cloud holds runs, artifacts, comparisons, and share links.
- [Quickstart](https://docs.worldflux.ai/docs-site/quickstart.md): Three commands to a synced run. Five more to a comparison. The CLI keeps secrets in your keychain, never in the manifest.

## OpenAPI Specs

- [openapi](https://docs.worldflux.ai/api-reference/openapi.json)