docs/adr/0003-herdr-fork-in-monorepo.md

ADR 0003: clankie-herdr Fork in the Monorepo

  • Status: Superseded by ADR-0008
  • Date: 2026-07-05

Context

Clankie depends on clankie-herdr, its Herdr fork, as the persistent terminal stage. Some stage behavior uses fork work before it is available in upstream Herdr, including pane/session API capabilities used by the agent and mobile window.

Keeping that fork outside the Clankie repository makes stage API changes move on a different commit timeline from the agent and iOS surfaces that consume them.

Decision

The Clankie-owned Herdr fork is called clankie-herdr and lives in the monorepo at:

herdr/

The directory contains the clankie-herdr fork source and its package-local docs, tooling, and instructions. The package remains a Rust project with its own Cargo.lock, justfile, docs site, and Herdr-specific AGENTS.md.

Upstream Herdr remains the rebase source for generally useful terminal-runtime work, but Clankie development treats herdr/ as the local clankie-herdr source tree alongside the agent, iOS app, contract, and media plane.

Consequences

  • Stage API changes can land with the Clankie agent and mobile code that depends on them.
  • clankie-herdr fork work still follows Herdr's package-local instructions and checks.
  • Root CI includes a Linux Herdr check from the herdr/ package directory.
  • Herdr build output and local state stay ignored by package-local and root ignore rules.