Installation

System requirements, pip/uv install, and optional extras.

Requirements

Install

With pip

pip install flux-core

With uv

uv add flux-core

With Poetry

poetry add flux-core

Verify

flux --help

You should see the top-level command list (agent, workflow, execution, start, …). To check the installed version specifically:

pip show flux-core | grep Version

(The flux CLI itself doesn’t expose a --version flag in v0.56.0.)

Optional extras

Flux’s agent framework supports multiple LLM providers. Install only what you’ll use.

Anthropic

pip install anthropic
export ANTHROPIC_API_KEY="sk-..."

OpenAI

pip install openai
export OPENAI_API_KEY="sk-..."

Google Gemini

pip install google-genai
export GOOGLE_API_KEY="..."

Ollama (local)

Install Ollama, then pull a model:

ollama pull llama3.2

No API key needed; agents talk to http://localhost:11434.

Storage

Flux uses an embedded SQLite database by default, written to a .flux/ directory in your project. No setup needed for local development. For production, use PostgreSQL — install the driver extra:

pip install 'flux-core[postgresql]'

This brings in psycopg v3. See Operate → Server → Storage backends.

Docker

An official Docker image covers every role from one build: it defaults to the server, and FLUX_MODE=worker or FLUX_MODE=mcp selects the other modes. The image runs as a non-root user, ships the postgresql, observability, and ai extras, and is published with semver version tags — pin the tag to the flux-core version you target. See Deployment → Docker.

Next

Quickstart. Run a workflow in five minutes.