> For the complete documentation index, see [llms.txt](https://fleet.hackmap.win/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://fleet.hackmap.win/reference/compatibility.md).

# Compatibility

Fleet ships as one wheel — `fleet-framework` — so there's only one version to track. The framework, the browser pool, the Cloudflare solver, the proxy providers, and every abstract contract (`fleet_serp`, `fleet_news`, `fleet_jobs`, ...) all live under `src/` and release together. External plugins (your own automations, the SERP engine plugins, the CF harvester) depend on `fleet-framework` and pin to a compatible version.

## Why one version

Several APIs cross internal package boundaries:

| Surface                                            | Crosses                                                             |
| -------------------------------------------------- | ------------------------------------------------------------------- |
| `Backend` protocol + `RawItem` dataclass           | `fleet.core` defines, every backend impl depends on the exact shape |
| `Stream[P]` / `Queue[P]` / `Pool[P, T]` typed refs | Shared contracts modules import from `fleet.core` and from plugins  |
| WS protocol frames + `PROTOCOL_VERSION`            | `fleet` master + every worker                                       |
| `Solver[R]` protocol                               | `fleet_browser` defines, `fleet_cloudflare` implements              |
| `BaseConfig` + reconcile rules                     | `fleet.core` defines, every plugin's `Config` extends               |

Any of these changing breaks consumers. SemVer minor bumps within `0.x` may break — we treat the major as the stable boundary while `0.x`. Track `ROADMAP.md` for what's coming.

## Upgrading

The safe order:

1. Drain workers (`POST /api/v1/automations/{type}/workers/{id}/drain` or `kubectl drain` if you wrap them).
2. Upgrade the master.
3. Upgrade workers.

Workers report their `fleet-framework` version on register; the master logs a WARNING on major mismatch. A `PROTOCOL_VERSION` mismatch is a hard 4000 close — the worker fails to register.

## Pre-1.0 stability promise

There isn't one. The `0.x` line will break compatibility freely between minor versions to clean up the API surface. Each release notes what changed in `CHANGELOG.md`. Once we hit `1.0.0`, SemVer applies — no breaking changes within `1.x`.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://fleet.hackmap.win/reference/compatibility.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.