Get started with fw
Each step is one action. Do them in order.
1. Open a terminal
Section titled “1. Open a terminal”On Windows, open PowerShell. On Linux, open any terminal.
2. Install fw
Section titled “2. Install fw”Follow the install page for your system. It takes one command.
3. Check the version
Section titled “3. Check the version”Run this command.
fw --versionThe output starts with fw 2026.11.0 or a newer number.
4. Check your machine
Section titled “4. Check your machine”fw doctorThe command checks the toolchain, FX_HOME, git, API keys and Ollama on port 11434. Fix what it reports, then run it again.
5. Go to your project
Section titled “5. Go to your project”cd path/to/your/project6. Describe the project to agents
Section titled “6. Describe the project to agents”fw onboardThe usage is fw onboard [dir] | fw onboard export <all|mcp|opencode|zed> [--dir <dir>]. The command describes the workspace for agents.
7. Write the agent config files
Section titled “7. Write the agent config files”fw onboard export allThis writes .mcp.json, opencode.json and .zed/settings.json in the project. Open one and check that it lists the fw MCP server.
8. Ask the agent a question
Section titled “8. Ask the agent a question”fw ask "what does this project do?"The agent needs a model endpoint. Run fw models to see the configured providers.
9. Start the server
Section titled “9. Start the server”fw serve 127.0.0.1:8787The usage is fw serve [host:port]. Open http://127.0.0.1:8787/ in your browser to see the chat page. The server also answers on /mcp, /acp and /a2a: see the API reference.
- CLI reference: every command.
- Agents guide: connect Claude Code, Zed or OpenCode.
- Learning guide: let fw learn from your repository.