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 follows | a hook, and its context files |
|---|---|
| A new version arrives | after the next tool call |
| Set up | one command |
| Checked against | Crush v0.101.0, against its hooks documentation |
| Systems | Wherever 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:
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.jsonandgiven/out of git..crushrc: the hooks. Commit it.
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 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.mdas 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.
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 see | Why | What to do |
|---|---|---|
| Running the hook by hand prints nothing | No .instruction/follow.json in the folder or above it, up to the repository's root; or it gave this version moments ago | Run 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 it | Offline, not signed in, or the address is wrong, and there is no copy yet | instruction 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 one | Nothing to do on this machine: the session keeps the version it has. See How following works |
| A private instruction isn't read | The command isn't signed in | instruction login (--device on a machine without a browser) |
| Still stuck | Ask us |
Related
- Other coding agents: every tool at a glance
- How following works: the follow file, the hooks, offline behaviour
- Gemini CLI
- Antigravity
- GitHub Copilot CLI
- Live updates