Skip to content

Commit fc9eb44

Browse files
committed
Add remote access documentation for af start --allow-insecure-remote
- Document --allow-insecure-remote flag in README.md - Add detailed Remote Access section to agent-farm.md - Include security warnings and SSH tunneling alternative - Update both codev/ and codev-skeleton/ versions
1 parent 0a3eba2 commit fc9eb44

5 files changed

Lines changed: 139 additions & 3 deletions

File tree

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -358,6 +358,36 @@ af stop
358358

359359
The `af` command is globally available after installing `@cluesmith/codev`.
360360

361+
### Remote Access
362+
363+
Access your Agent Farm dashboard from another device (tablet, phone, or laptop):
364+
365+
```bash
366+
# Enable remote access (binds to 0.0.0.0)
367+
af start --allow-insecure-remote
368+
```
369+
370+
Then open `http://<your-machine-ip>:4200` from any device on your network.
371+
372+
**Find your IP:**
373+
```bash
374+
# macOS
375+
ipconfig getifaddr en0
376+
377+
# Linux
378+
hostname -I | awk '{print $1}'
379+
```
380+
381+
**⚠️ Security Note:** The `--allow-insecure-remote` flag provides no authentication. Only use on trusted networks. For secure remote access, use SSH tunneling:
382+
383+
```bash
384+
# From remote machine, create secure tunnel
385+
ssh -L 4200:localhost:4200 user@dev-machine
386+
# Then open http://localhost:4200
387+
```
388+
389+
See [CLI Reference](codev/resources/commands/agent-farm.md#remote-access) for full details.
390+
361391
### Autonomous Builder Flags
362392

363393
Builders need permission-skipping flags to run autonomously without human approval prompts:

codev-skeleton/resources/commands/agent-farm.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ af start [options]
3030
- `-c, --cmd <command>` - Command to run in architect terminal
3131
- `-p, --port <port>` - Port for architect terminal
3232
- `--no-role` - Skip loading architect role prompt
33+
- `--allow-insecure-remote` - Bind to 0.0.0.0 for remote access (see below)
3334

3435
**Description:**
3536

@@ -51,7 +52,59 @@ af start -p 4300
5152

5253
# Start with specific command
5354
af start -c "claude --model opus"
55+
56+
# Start with remote access enabled
57+
af start --allow-insecure-remote
58+
```
59+
60+
#### Remote Access
61+
62+
By default, Agent Farm binds to `localhost` (127.0.0.1), making it accessible only from the local machine. To access the dashboard from another device (e.g., a tablet, phone, or another computer on your network):
63+
64+
```bash
65+
af start --allow-insecure-remote
66+
```
67+
68+
This binds the server to `0.0.0.0`, making it accessible from any network interface.
69+
70+
**Finding your machine's IP:**
71+
```bash
72+
# macOS
73+
ipconfig getifaddr en0 # WiFi
74+
ipconfig getifaddr en1 # Ethernet
75+
76+
# Linux
77+
hostname -I | awk '{print $1}'
78+
```
79+
80+
**Accessing remotely:**
5481
```
82+
http://<your-ip>:4200
83+
```
84+
85+
**⚠️ Security Warning:**
86+
87+
The `--allow-insecure-remote` flag provides **no authentication**. Anyone on your network can:
88+
- View and interact with all terminals
89+
- Execute commands as your user
90+
- Access and modify your code
91+
92+
**Only use this on trusted networks** (home WiFi, isolated development networks). Never use on:
93+
- Public WiFi (coffee shops, airports)
94+
- Shared office networks without VPN
95+
- Any network with untrusted users
96+
97+
**For secure remote access**, consider:
98+
1. **SSH tunneling** (recommended):
99+
```bash
100+
# On remote machine, tunnel to your dev machine
101+
ssh -L 4200:localhost:4200 user@your-dev-machine
102+
# Then open http://localhost:4200 on the remote machine
103+
```
104+
105+
2. **VPN** - Access your home/office network securely
106+
107+
3. **Tailscale/ZeroTier** - Mesh VPN for secure device-to-device connections
55108

56109
---
57110

codev/resources/commands/agent-farm.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ af start [options]
3030
- `-c, --cmd <command>` - Command to run in architect terminal
3131
- `-p, --port <port>` - Port for architect terminal
3232
- `--no-role` - Skip loading architect role prompt
33+
- `--allow-insecure-remote` - Bind to 0.0.0.0 for remote access (see below)
3334

3435
**Description:**
3536

@@ -51,7 +52,59 @@ af start -p 4300
5152

5253
# Start with specific command
5354
af start -c "claude --model opus"
55+
56+
# Start with remote access enabled
57+
af start --allow-insecure-remote
58+
```
59+
60+
#### Remote Access
61+
62+
By default, Agent Farm binds to `localhost` (127.0.0.1), making it accessible only from the local machine. To access the dashboard from another device (e.g., a tablet, phone, or another computer on your network):
63+
64+
```bash
65+
af start --allow-insecure-remote
66+
```
67+
68+
This binds the server to `0.0.0.0`, making it accessible from any network interface.
69+
70+
**Finding your machine's IP:**
71+
```bash
72+
# macOS
73+
ipconfig getifaddr en0 # WiFi
74+
ipconfig getifaddr en1 # Ethernet
75+
76+
# Linux
77+
hostname -I | awk '{print $1}'
78+
```
79+
80+
**Accessing remotely:**
5481
```
82+
http://<your-ip>:4200
83+
```
84+
85+
**⚠️ Security Warning:**
86+
87+
The `--allow-insecure-remote` flag provides **no authentication**. Anyone on your network can:
88+
- View and interact with all terminals
89+
- Execute commands as your user
90+
- Access and modify your code
91+
92+
**Only use this on trusted networks** (home WiFi, isolated development networks). Never use on:
93+
- Public WiFi (coffee shops, airports)
94+
- Shared office networks without VPN
95+
- Any network with untrusted users
96+
97+
**For secure remote access**, consider:
98+
1. **SSH tunneling** (recommended):
99+
```bash
100+
# On remote machine, tunnel to your dev machine
101+
ssh -L 4200:localhost:4200 user@your-dev-machine
102+
# Then open http://localhost:4200 on the remote machine
103+
```
104+
105+
2. **VPN** - Access your home/office network securely
106+
107+
3. **Tailscale/ZeroTier** - Mesh VPN for secure device-to-device connections
55108

56109
---
57110

packages/codev/package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/codev/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@cluesmith/codev",
3-
"version": "1.4.10",
3+
"version": "1.4.11",
44
"description": "Codev CLI - AI-assisted software development framework",
55
"type": "module",
66
"bin": {

0 commit comments

Comments
 (0)