Reference

Reference is the section you reach for when you know what you’re looking for. Every public symbol, every CLI command, and every REST endpoint has a page here.

SDK is the Python surface — workflow, task, the built-in tasks, ExecutionContext, the scheduling primitives, and the helpers. Auto-generated from the source by an introspection script. Start with the SDK index.

CLI documents every Flux command group: workflow, execution, worker, schedule, secrets, agent, auth, principals, roles, health, start, config, and service. Auto-generated from the Click command tree. Start with the CLI index.

REST API covers the HTTP surface — every route exposed by flux start server. Hand-authored from flux/server.py so it stays grounded in the actual handlers. Start with the REST API overview.

MCP server documents what flux start mcp exposes to Model Context Protocol clients. Hand-authored. Start with the MCP server overview.

Configuration covers flux.toml, the environment variables that override it, and the precedence rules between the two. Start with configuration files.