magus v0.4.3 is out. See what's new
¶ View markdown source · ✎ Suggest an edit
2 min read

Break now, hold still later

Durability is what I want magus to be known for: the tool that works the way it worked last year, that you put underneath something and stop thinking about. Go is the model. Code from a decade ago still builds, and that is a maintained commitment rather than luck.

You earn that by not moving, over years, and holding still is not passive. You cannot stay put on top of decisions you did not think through. Not moving later is paid for with forethought now, and with fixing what is wrong while the blast radius is small. So before 1.0 a name, flag or format that turns out wrong is renamed, removed or changed outright, with no compatibility shim, no dual reader and no deprecated alias. Carrying an incoherent name forever costs more than one breaking release.

The pattern I refuse is the one too many build tools run: ship a half-built abstraction, push everyone onto it, deprecate it a few releases later, and push everyone onto the next one. That is what too many hands on a design with too little confidence in it looks like from the outside. Hammer the abstraction out first, here, while only this repository pays for the rework, and ask people to move once, to something you are sure of.

After 1.0 the direction flips, and the compatibility contract says what is promised: additive keys, a declared version floor, nothing that vanishes out from under anyone.

Enforced by

  • AGENTS.md: pre-1.0, breaking is fine, and a compat shim, dual reader, fallback or Deprecated: alias needs Eli's yes first.
  • An approved shim carries compat(until: <condition>):.
  • Compatibility states what holds after 1.0.

Good

The rename lands whole, in one change, with the old name gone:

magus session hook is now `magus shell`, which takes the same flags and stdin.
Re-run `magus agent harness install` to rewrite host wiring that still calls the old path

Bad

// Deprecated: use Shell. Kept so existing hooks keep working.
func SessionHook(args []string) error { return Shell(args) }

At 0.x nobody depends on the old name yet, and the alias is how somebody comes to. It doubles what every reader and every agent has to learn.

See also

designprinciplecompatibility
Last updated (2df714e8)
Glossary

Op

A single tool-native command a target composes (long form: operation); the middle of the work hierarchy (Spell to Op to Target). Op in full.

CI

An ordinary target you compose yourself with ctx.needs; magus does not hardcode its stages. It is the anchor magus affected ci keys off, and ci strips the rw charm. CI in full.

Agent

A model working through an agent host such as Claude Code, Codex, Cursor or OpenCode. magus treats an agent as one more caller of its CLI, MCP tools and console, held to the same checks as a person. Agent in full.

Tool

An action a model can call through its host: a name, a description, a typed input and a result. magus serves its tools over MCP, each a read of the workspace model or a run of the CLI it already has. Tool in full.

Harness

The deterministic scaffolding around the work on a change, for a person or an agent: compiler errors, formatters, linters, checks, gates, leases and hooks, placed at points a person chose. Around an agent's loop, magus supplies one and keeps it outside. Harness in full.

Session

An agent host's conversation, by the id the host delivers to its hooks. magus never mints one: a record with no session is unattributed, and the OS user it carries says whose account ran it. Session in full.

Run

One target executing under one magus invocation, such as magus run test web or magus affected ci. A run keeps its captured output behind an output reference. Every magus run is a run whether or not any job asked for it; see Job for how the two relate. Run in full.

Lease

The grant a holder takes on a job: the write and read paths that job declared, enforced in the checkout that took it with magus job exec. A job is the piece of work; a lease is permission over it. Lease in full.

Conventions

Placeholders

Angle brackets mark a value you replace with your own; never type the brackets:

magus run <target>
magus completion <shell>    # e.g. bash, zsh, fish

<target>, <path>, <shell>, <name> and the like are stand-ins, not literal text.