Quick start
fx is an open-source coding agent built as a small native binary. It reads your code, edits files, and runs commands from an interactive shell or a single fx ask request.
Install
$
curl -fsSL https://fx.sh/setup.sh | bashSee Installation for other versions or help with PATH.
Start fx
Open a project and start an interactive session:
cd path/to/project
fx
In fx, open the provider picker:
/provider
Choose a ChatGPT or Grok subscription, a Vercel account, or an AI Gateway API key. Complete sign-in or paste the key when prompted. See Authentication for other login methods.
Send a prompt:
Run the tests and fix any failures.
Things to know
| Action | How |
|---|---|
| Steer fx while it works | Send a follow-up prompt. |
| Include a file | Type @ and choose it. |
| Browse commands | Type /. |
| Update fx | Run fx upgrade, or press ctrl+g when an update is ready. |
| Open Full detail | Press ctrl+o. |
| Interrupt fx | Press escape twice. |
| Turn on sounds | Run /sound on. |
| Change permissions | Run /permissions. The default is auto. |
Run one request
Use fx ask when you do not need an interactive session:
$
fx ask "explain what this repository does"See fx ask for scripting and structured output.
Resume
fx saves your conversations. From the same project, resume with:
$
fx -cUse fx -r to choose another session.
Next: Working with fx.