Crush

Make a project follow an instruction in Crush: one command adds its hook, a context file covers the start, and a new version arrives after the next tool call. The same setup for other tools, and how each one takes a new version, is on Other coding agents.

At a glance

How it followsa hook, and its context files
A new version arrivesafter the next tool call
Set upone command
Checked againstCrush v0.101.0, against its hooks documentation
SystemsWherever the tool and Node.js 20.19 or later run

What you need: Node.js 20.19 or later, the instruction.md package (npm i -g instruction.md, 0.11.0 or later) and @instruction.md/agents 0.4.1 or later, which instruction agents … runs. Every instruction agents … command also runs, without installing anything, as npx -y @instruction.md/agents …, and every instruction … command as npx -y instruction.md ….

Set up

In your project's folder, signed in (instruction login), run:

Shell
instruction agents follow instruction://acme/support-agent@stable --host crush --write

It writes, merged into what is already there:

  • .instruction/follow.json: the instruction the project follows. Commit it.
  • .instruction/.gitignore: keeps the fetched copy (current.md), state.json and given/ out of git.
  • .crushrc: the hooks. Commit it.
.crushrc
hook add PostToolUse --name instruction-md --command "npx -y @instruction.md/agents hook crush" --timeout 5

Crush adds a hook's context only after a tool call; for a session's start add ".instruction/current.md" to context_paths in crush.json.

What happens

Crush takes what a hook adds only after a tool call, so that is when a new version arrives. Its session-start and turn-start hooks only observe.

For the start of a session, list the copy the hook keeps in context_paths. instruction connect --host crush <uri> prints it with the MCP server:

crush.json
// crush.json — Crush reaches instruction.md through this CLI's stdio server; the instruction is read when a session starts
{
  "mcp": {
    "instruction-md": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "instruction.md",
        "mcp",
        "--follow",
        "instruction://acme/support-agent@stable",
        "--url",
        "https://instruction.md/mcp"
      ]
    }
  },
  "context_paths": [
    ".instruction/current.md"
  ]
}
// sign the bridge in once: npx -y instruction.md login
// a new version after the next tool call (Crush's hooks add context only there): npx -y @instruction.md/agents connect --host crush instruction://acme/support-agent@stable --with-hooks --write

Caveats and what isn't verified

  • Crush builds its context once per session, so the start reads .instruction/current.md as the hook last left it.

Check it worked

Run the hook by hand, as the tool would at that event. It prints what the tool receives: the instruction's whole text the first time, and nothing when you run it again right away, because a session gets each version once.

Shell
echo '{}' | npx -y @instruction.md/agents hook crush --event PostToolUse --dir .

Then start a new session and ask which instructions it follows. Once a session has read it, .instruction/current.md holds the copy the hooks keep, and the instruction's Agents card counts the follower under this tool.

Stop following

  • Delete the line hook add PostToolUse --name instruction-md … from .crushrc.
  • Delete .instruction/follow.json, or the whole .instruction/ folder.

If it doesn't work

What you seeWhyWhat to do
Running the hook by hand prints nothingNo .instruction/follow.json in the folder or above it, up to the repository's root; or it gave this version moments agoRun the setup in the project's folder, or pass --dir. A version the session already has isn't given again: nothing is wrong
instruction.md: couldn't read …; this session goes on without itOffline, not signed in, or the address is wrong, and there is no copy yetinstruction login, then check the address in .instruction/follow.json
instruction.md: a newer version of … is held (…)The new version's signature doesn't check out, and the follow file asks for oneNothing to do on this machine: the session keeps the version it has. See How following works
A private instruction isn't readThe command isn't signed ininstruction login (--device on a machine without a browser)
Still stuckAsk us

Last checked against the product:

Was this page helpful? Report a problem