Skip to content

docs: describe fleet.yaml #215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
outofcoffee merged 1 commit into from
Sep 19, 2026
Merged

docs: describe fleet.yaml #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ Four words carry the whole tool:

- [Getting started](getting-started.md) — the end-to-end flow
- [The `Spinloop` file](spinloop-file.md) — syntax and examples
- [The `fleet.yaml` file](fleet-file.md) — the file a fleet is built from:
its nodes, its token references, and what it refuses
- [Running on a cloud GPU](commands/remote.md) — the same Spinloop, on a
machine that stops when you do
- [The HTTP control API](http-api.md) — driving a supervised engine over
Expand Down Expand Up @@ -87,7 +89,7 @@ including the `SPINLOOP_REMOTE_*` overrides:
| `SPINLOOP_BASE_URL` | Overrides any provider's API base URL (`--base-url`/`-u` beats it) |
| `SPINLOOP_API_TOKEN` | Bearer token for the daemon [control API](http-api.md) |
| `SPINLOOP_LOG_LEVEL` | How much `spinloop daemon`/`spinloop serve` record — `debug`, `info` (default), `warn`, `error` (`--log-level` beats it) |
| *(named by `tokenEnv`)* | A [fleet](commands/fleet.md) node's bearer token — `fleet.yaml` names the variable, never the value |
| *(named by `tokenEnv`)* | A fleet node's bearer token — the [fleet file](fleet-file.md#tokens) names the variable, never the value |
| `DEEPSEEK_API_KEY`, `OPENAI_API_KEY`, … | Provider API keys — `spinloop provider list` shows which each provider reads |
| `OLLAMA_BASE_URL`, `LLAMACPP_BASE_URL`, `OMLX_BASE_URL`, `VLLM_BASE_URL`, `MTPLX_BASE_URL`, `OPENAI_BASE_URL` | Per-provider endpoint overrides |
| `AWS_REGION` | Region for AWS Bedrock |
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/alias.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ spinloop harness apply team-default
```

It is stored and resolved just like a local one — see
[Fetching a Spinloop from a URL](../spinloop-file.md#fetching-an-spinloop-from-a-url).
[Fetching a Spinloop from a URL](../spinloop-file.md#fetching-a-spinloop-from-a-url).

## Naming one for the whole shell

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/code.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ spinloop code --fleet ./fleet.yaml # route through a fleet, or its gateway

`code` is the only way to launch an agent against a fleet: `spinloop fleet
harness` was removed, and typing it names this command instead. A fleet file
that names a [gateway](fleet.md#gateway) needs no Spinloop at all — the gateway
that names a [gateway](../fleet-file.md#gateway) needs no Spinloop at all — the gateway
resolves the model per request — so `spinloop code --fleet ./fleet.yaml` is a
complete launch on a machine holding nothing but the fleet file.

Expand Down
Loading
Loading