{"slug":"agents-md","name":"AGENTS.md","kind":"runbook","what":"A simple open format, basically a README for coding agents, that tells them how to work in your repo.","page":"https://insidethemachine.ai/setups/agents-md","status":"docs-checked","status_label":"Not run: commands checked against the official docs only","status_note":"Commands checked against the official docs on 2026-10-15. Not run end to end.","wrapper":"The wrapper scripts are generated from the site data. Every .sh passed bash -n and shellcheck and ran in plan mode on Linux (Debian 13). Every .ps1 passed the PowerShell parser and chat.ps1 ran in plan, verify and rollback mode under PowerShell 7 on Linux with Windows calls mocked. Not run on macOS or real Windows.","wrapper_tested":"2026-10-16, Debian 13 box: install wrote AGENTS.md and the check passed; a second run left the existing file alone; rollback ran `git rm` (refuses a staged file, by design).","sh":"https://insidethemachine.ai/install/agents-md.sh","ps1":null,"md":"https://insidethemachine.ai/install/agents-md.md","json":"https://insidethemachine.ai/install/agents-md.json","one_liner":"curl -fsSL https://insidethemachine.ai/install/agents-md.sh | bash","one_liner_windows":null,"actions":{"install":"curl -fsSL https://insidethemachine.ai/install/agents-md.sh | bash","plan":"curl -fsSL https://insidethemachine.ai/install/agents-md.sh | bash -s -- plan","verify":"curl -fsSL https://insidethemachine.ai/install/agents-md.sh | bash -s -- verify","rollback":"curl -fsSL https://insidethemachine.ai/install/agents-md.sh | bash -s -- rollback --yes"},"env":{"ITM_RAM":"memory in GB instead of detecting it"},"model_by_memory_gb":null,"low_memory":null,"platforms":{"macos":{"install":[{"title":"Install AGENTS.md","lines":[{"k":"write","c":"cat > AGENTS.md <<'EOF'\n# AGENTS.md\n\n## Dev environment tips\n- <how to install deps / run the app>\n\n## Testing instructions\n- <exact test command>\n\n## PR instructions\n- Always run lint and tests before committing.\nEOF"}]},{"title":"Configure (your choices)","lines":[{"k":"note","c":"point your agent at the repo; agents that support AGENTS.md read it automatically"}]}],"verify":[{"run":"test -f AGENTS.md && head -5 AGENTS.md","expect":"file exists at the repo root"}],"rollback":[{"k":"run","c":"git rm AGENTS.md   # or: rm AGENTS.md"}]},"linux":{"install":[{"title":"Linux: same steps as macOS","lines":[{"k":"note","c":"Our data lists Linux as supported but has no separate Linux steps, so these are the macOS steps. brew lines are skipped; install those tools with your package manager."}]},{"title":"Install AGENTS.md","lines":[{"k":"write","c":"cat > AGENTS.md <<'EOF'\n# AGENTS.md\n\n## Dev environment tips\n- <how to install deps / run the app>\n\n## Testing instructions\n- <exact test command>\n\n## PR instructions\n- Always run lint and tests before committing.\nEOF"}]},{"title":"Configure (your choices)","lines":[{"k":"note","c":"point your agent at the repo; agents that support AGENTS.md read it automatically"}]}],"verify":[{"run":"test -f AGENTS.md && head -5 AGENTS.md","expect":"file exists at the repo root"}],"rollback":[{"k":"run","c":"git rm AGENTS.md   # or: rm AGENTS.md"}]},"windows":null}}