Getting Started

This path takes you from installation to a safe first change in an existing repository.

#Before you begin

You need:

• a terminal
• a local Git repository to explore
• an API key for OpenAI, Anthropic, or Gemini, or a running Ollama installation

The prebuilt Flux release does not require Node.js. Node.js and pnpm are only needed when developing Flux itself.

#Follow this path

1. Install Flux and verify that the flux command works.
2. Connect a provider so Flux can use a model.
3. Complete your first task in a real repository, beginning in read-only mode.
4. Configure your project with shared instructions and defaults when you are ready.

At the end, you will know how to open the correct workspace, give Flux exact context, review a proposed change, and check what changed.

If you are already set up, go directly to the first-task walkthrough.