You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guide/agent-setup.md
+26Lines changed: 26 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,6 +55,8 @@ This automatically:
55
55
- Installs the dashboard
56
56
- Verifies the installation
57
57
58
+
> CLI vs file-based? Use CLI commands for human-driven workflows and automation scripts. Use the file-based protocol (`$AGENT_RELAY_OUTBOX`) when an AI agent needs to interact without shell access.
59
+
58
60
**Option B: npm install**
59
61
60
62
If Node.js 18+ is already installed:
@@ -88,6 +90,12 @@ Verify the daemon is running:
88
90
agent-relay status
89
91
```
90
92
93
+
If the daemon writes logs into your shell, run it in the background with logs captured:
94
+
```bash
95
+
agent-relay up --dashboard >~/.agent-relay/daemon.log 2>&1&
96
+
```
97
+
Then use `tail -f ~/.agent-relay/daemon.log` when you need the logs.
98
+
91
99
### Step 4: Install MCP Server (Recommended)
92
100
93
101
Give AI agents native relay tools via Model Context Protocol:
@@ -112,6 +120,24 @@ open http://localhost:3888
112
120
113
121
The dashboard should show your connection and allow you to spawn agents.
114
122
123
+
### Quick troubleshooting tips
124
+
125
+
-**Clean, scriptable output:** Use `--json` on `agent-relay who` and `agent-relay agents` to avoid daemon log noise, e.g. `agent-relay who --json | jq '.'`.
126
+
-**Daemon vs agent status:**`agent-relay status` checks the socket in the current project. If you started the daemon from a different directory or with a custom data dir, set the same env when checking:
127
+
`AGENT_RELAY_DATA_DIR=~/.local/share/agent-relay agent-relay status`. If the dashboard is up, `curl http://localhost:3888/health` should return JSON with `"status":"ok"`.
128
+
-**`who` feels stuck or times out:** Make sure the daemon is up first (`agent-relay status`). If the daemon is still starting, retry with `agent-relay who --json`.
129
+
-**Waiting for a spawn to finish (no built-in flag yet):**
130
+
```bash
131
+
agent-relay spawn Worker claude "Run the build"
132
+
# Stream logs while it works
133
+
agent-relay agents:logs Worker --follow &
134
+
# Wait until the agent goes offline (status flips after ~30s of inactivity)
0 commit comments