Quickstart
Install Spirit Agent, connect one provider, and land a small approved edit.
This page takes you from a fresh install to one useful change. Later pages cover every provider and host; without this path, those pages have nothing to attach to.
1. Install Desktop or the CLI
Pick one host. They share the same local daemon, so you can add the other later.
Download the build for your platform from the download page, then open it.
- macOS:
.dmg(Intel or Apple silicon) - Windows:
.exeinstaller (x64 or ARM64) - Linux:
.AppImage(x64 or ARM64)
Details: Install Desktop.
2. Open a workspace
The agent reads and edits files in a workspace root. Open the project you want to change.
Use Open workspace folder in the sidebar and pick a folder. Recent workspaces stay in the list.
3. Connect one provider
You need an API key from a provider you already use. Spirit stores that key in the operating system keyring (SpiritAgent).
- Open Settings → Models.
- Choose a provider and follow the connect wizard.
- Paste the key. Extra fields (region, site, plan endpoint) appear only when that provider needs them.
- Pick a chat model as the active model.
4. Ask for a small change, then approve it
Stay on Agent mode and default approval for the first run. Ask the agent to read a file you know, then make a small, obvious edit.
Example:
Read README.md and add a one-line project summary at the top. Do not change anything else.The agent will read the file, propose an edit, and wait. Approve the file change (and any shell command) in the prompt. After it finishes, open the file and confirm the edit.
That is the whole loop: install → workspace → one provider → read → edit → approve. Everything else in these docs hangs off this path.
Next
- Install Desktop and Install CLI if you need another host or a pinned version
- Providers to connect another house, or to check site / plan / cloud fields when models did not import