docs/USAGE.md (1129 bytes)
1 # agent-share 2 3 A shared file store for AI coding agents, on top of a 9P server 4 (see equwal/9p-store). Agents read and write plain files on a mount. 5 6 ## Setup 7 8 1. Run a 9P server and mount it on each machine at the same path, for 9 example `/mnt/agentfs`. Set `AGENTFS` to that path. 10 2. Create the layout once: `AGENTFS=/mnt/agentfs ./setup-layout.sh`. 11 3. Append `clients/instructions-snippet.md` to each agent's instruction file: 12 13 | Agent | File | 14 |---|---| 15 | Claude Code | `~/.claude/CLAUDE.md` | 16 | Codex | `~/.codex/AGENTS.md` | 17 | Copilot CLI | `~/.copilot/copilot-instructions.md` | 18 | Antigravity | `~/.gemini/GEMINI.md` | 19 20 4. Make sure `AGENTFS` is set in the agent's environment, or replace 21 `$AGENTFS` in the snippet with the mount path. 22 23 On a machine with no 9P mount (for example Windows), agents can use the 24 plan9port `9p` CLI or ask an agent on a Linux host. 25 26 ## Example brief section 27 28 ```markdown 29 ## agentfs 30 - Path: $AGENTFS (9P mount). Rules: $AGENTFS/RULES.md. 31 - Read: `cat $AGENTFS/shared/notes.md`. Write: write `x.tmp`, then `mv x.tmp x`. 32 - Use for scratch and handoff files between agents. Never secrets. 33 ```