CLI index

The Flux CLI is the operator surface. Every command group below is auto-generated from the Click command tree in flux/cli.py, so flags, defaults, and help text track the installed package.

The CLI splits into three rough buckets: things that define the workload, things that run it, and things that govern access to it.

Defining the workload

• flux workflow — register, list, inspect, and remove workflow definitions.
• flux execution — start executions, list them, fetch their event logs, and cancel.
• flux schedule — manage cron, interval, and once-off schedules.
• flux secrets — read and write the encrypted secrets store.
• flux agent — manage registered agents.

Running it

• flux start — entry point for flux start server, flux start worker, and flux start mcp.
• flux server — server-specific subcommands.
• flux worker — worker-specific subcommands.
• flux service — install and manage Flux as an OS service.
• flux health — probe a running server or worker.
• flux config — inspect the effective configuration.

Governing access

• flux auth — authenticate the CLI itself against a server.
• flux principals — manage users, service accounts, and API keys.
• flux roles — manage RBAC roles and bindings.