# STARTHERE — mgf-vm-core

> **Sibling library in the Magogi Foundation federation.**
> See [README.md](README.md) for what this library does; see
> [PUBLIC_API.md](PUBLIC_API.md) for the surface; see
> [mgf-common/FEDERATION.md](https://codeberg.org/magogi-admin/mgf-standard/src/branch/main/FEDERATION.md)
> for the federation contract.

`mgf-vm-core` is the pure VM-domain library for the distributed
vm-vmanager-app — the state machine, the engine-neutral `VmSpec`, the four
`Protocol` contracts (`HypervisorBackend`, `StorageBackend`,
`DeviceBackend`, `LifecycleObserver`), the shipped fakes, and the
cross-adapter conformance suite. No engine deps — no libvirt, no
Firecracker, no `mgf-hrb`.

---

## For consumers (using this library)

1. **Pin** in your `pyproject.toml`:
   ```toml
   dependencies = ["mgf-vm-core>=X.Y,<X.$((Y+1))"]
   ```
   See [CHANGELOG.md](CHANGELOG.md) for the current minor.
2. **Install:** `uv add mgf-vm-core` (or `pip install mgf-vm-core`).
3. **Read** [PUBLIC_API.md](PUBLIC_API.md) for the stable surface.
4. **Implementing an adapter?** The contract is
   `vm-vmanager-docs/component-specs/contracts.md` — read it first,
   then run this library's `mgf.vm.core.conformance` suite against
   your engine.
5. **Bootstrap your app** with mgf-common first — see
   [mgf-common/STARTHERE.md](https://codeberg.org/magogi-admin/mgf-common/src/branch/main/STARTHERE.md).
6. **Adopt the federation contract** — file your
   `MGF_STANDARDS_CONFORMANCE.md` per
   [DOC-15](https://codeberg.org/magogi-admin/mgf-standard/src/branch/main/docs/standards/DOCUMENTATION.md).
7. **Run** `mgf-common catch-up` periodically to verify
   federation drift; see [FEDERATION.md](https://codeberg.org/magogi-admin/mgf-standard/src/branch/main/FEDERATION.md) §6.

---

## For contributors

See [CONTRIBUTING.md](CONTRIBUTING.md). Standards are inherited
from [mgf-common](https://codeberg.org/magogi-admin/mgf-standard/src/branch/main/docs/standards/).

---

## Quick links

| Resource | Where |
|---|---|
| Library purpose | [README.md](README.md) |
| Stable surface | [PUBLIC_API.md](PUBLIC_API.md) |
| Release notes | [CHANGELOG.md](CHANGELOG.md) |
| Who depends on me | [DEPS.md](DEPS.md) |
| Conformance ledger | [docs/inprogress/MGF_STANDARDS_CONFORMANCE.md](docs/inprogress/MGF_STANDARDS_CONFORMANCE.md) |
| Conformance-level argument | [STANDARDS_NOTE.md](STANDARDS_NOTE.md) |
| System docs (architecture, contracts, roadmap) | `vm-vmanager-docs/` |
| Federation contract | [mgf-common/FEDERATION.md](https://codeberg.org/magogi-admin/mgf-standard/src/branch/main/FEDERATION.md) |
| Cross-project standards | [mgf-standard/docs/standards/](https://codeberg.org/magogi-admin/mgf-standard/src/branch/main/docs/standards/) |
