Skip to content

Runtime Registry

This document specifies how the Spawnfile project tracks, pins, and categorizes the runtimes it targets.


The compiler emits output for specific runtimes. Those runtimes are external projects with their own release cadences. The runtime registry is the mechanism for:

  • declaring which runtimes the project knows about
  • pinning the version each adapter was written and tested against
  • tracking which runtimes have active adapters vs which are still under research

The runtime registry is a YAML file at the repository root: runtimes.yaml.

runtimes:
<name>:
remote: <git clone URL>
ref: <pinned git ref — tag, SHA, or branch>
default_branch: <main | master>
install:
kind: <container_image | npm | github_release_archive | github_release_bundle | source_repo>
status: <active | exploratory | deprecated>
FieldRequiredDescription
remoteyesGit clone URL for the runtime repository
refyesPinned git ref — should be the latest stable release tag
default_branchyesThe repository’s primary branch name
installnoPinned install strategy for the verified runtime version
statusyesLifecycle status of this runtime in the Spawnfile project

The install block declares which compiled artifact or packaged install surface Spawnfile should use for container builds at the pinned runtime version.

Supported kinds in v0.1 are:

KindRequired FieldsMeaning
container_imageimage, tagInstall from a pinned runtime container image
npmpackage, versionInstall a pinned npm package version
github_release_archiverepository, tag, binary, assetsDownload a pinned release archive and install a platform-specific binary
github_release_bundlerepository, tag, assetDownload a pinned release bundle tarball
source_repononeFallback install from the pinned source repo ref

install is OPTIONAL at the schema level because exploratory runtimes may not yet have a verified build story. Active runtimes intended for spawnfile build SHOULD provide a verified install strategy.

StatusMeaning
activeHas a working compiler adapter in src/runtime/<name>/
exploratoryResearch exists in specs/research/RUNTIME-NOTES.md but no adapter yet
deprecatedWas previously active, adapter is no longer maintained

Runtime APIs, config formats, and CLI interfaces change across versions. An adapter written against openclaw v2026.2.3 may not produce valid output for v2026.3.13. Pinning makes this explicit.

The ref field should point to the latest stable release tag. Stable means:

  • no pre-release suffixes like -alpha, -beta, -rc, -dev
  • exception: if a runtime only publishes pre-release tags, pin the most recent one and note it

Bump ref when:

  • a new stable release is available and the adapter has been verified against it
  • the adapter is being updated to support new runtime features from a newer version

Do not bump ref speculatively. The pin represents “the adapter works at this version.”

If the install artifact version differs from the source ref, both values should still be updated intentionally in the same review. The runtime registry is the source of truth for the exact runtime version Spawnfile supports.

scripts/runtimes.sh reads runtimes.yaml and clones or checks out each runtime at its pinned ref.

Terminal window
./scripts/runtimes.sh # sync all runtimes
./scripts/runtimes.sh openclaw # sync one runtime

The cloned repositories live in runtimes/ at the repo root. This directory is gitignored.

These local clones are for research, blueprint generation, and adapter development. spawnfile compile should not require local runtime clones on the compiler machine; container build/install should use the registry pin plus the adapter’s install strategy.

In v0.1, generated Dockerfiles must not clone runtime repositories or rebuild runtime sources during image build when a verified compiled install strategy is available. source_repo exists as a registry/install fallback, not the intended default for active runtime builds.


  1. Add an entry to runtimes.yaml with status: exploratory
  2. Run ./scripts/runtimes.sh <name> to clone it
  3. Research the runtime and add findings to specs/research/RUNTIME-NOTES.md
  4. When ready to implement, create src/runtime/<name>/adapter.ts and change status to active

A runtime moves from exploratory to active when:

  • an adapter exists in src/runtime/<name>/
  • the adapter passes tests against the pinned version
  • the adapter is registered in src/runtime/registry.ts
  • the runtime has a verified install strategy in runtimes.yaml
  • the compiled output can be built and the runtime can boot at the pinned version
  • if the runtime exposes a host-reachable service, a host-side smoke check succeeds against that service

A runtime moves to deprecated when:

  • the upstream project is archived or abandoned
  • the adapter is no longer maintained
  • the runtime’s config surface has diverged beyond reasonable adapter maintenance

Deprecated runtimes stay in the registry for reference but the compiler should warn when targeting them.

Operational discoveries about a pinned runtime version — build quirks, auth surfaces, health endpoints, container boot behavior — should be recorded in specs/research/RUNTIME-NOTES.md. Current standardized communication-surface support and access-mode differences should be tracked in SURFACES.md.


  • SPEC.md defines the runtime field in manifests — the name must match a registered runtime
  • COMPILER.md defines how runtime adapters are invoked and how output is grouped by runtime
  • CONTAINERS.md defines how runtime container metadata is used to generate Dockerfiles
  • SURFACES.md defines the current portable communication-surface contract and runtime support matrix
  • research/RUNTIME-NOTES.md contains the per-runtime research that informs adapter design