Skip to content

feat: add AGENT_RDP_HOST and AGENT_RDP_PORT env vars, clean up env var docs #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thisnick merged 1 commit into from
Jan 24, 2026
Merged

feat: add AGENT_RDP_HOST and AGENT_RDP_PORT env vars, clean up env var docs #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,12 +99,12 @@ Input sent as `FastPathInputEvent` (mouse via `MousePdu`, keyboard via scancode

| Variable | Description |
|----------|-------------|
| `AGENT_RDP_SESSION` | Session name (default: "default") |
| `AGENT_RDP_HOST` | RDP server hostname or IP |
| `AGENT_RDP_PORT` | RDP server port (default: 3389) |
| `AGENT_RDP_USERNAME` | RDP username |
| `AGENT_RDP_PASSWORD` | RDP password |
| `AGENT_RDP_SESSION` | Session name (default: "default") |
| `AGENT_RDP_STREAM_PORT` | WebSocket streaming port (0 = disabled) |
| `AGENT_RDP_STREAM_FPS` | Frame rate for streaming (default: 10) |
| `AGENT_RDP_STREAM_QUALITY` | JPEG quality 0-100 (default: 80) |

## Release Process

Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,12 +310,12 @@ agent-rdp --json screenshot --base64

| Variable | Description |
|----------|-------------|
| `AGENT_RDP_SESSION` | Session name (default: "default") |
| `AGENT_RDP_HOST` | RDP server hostname or IP |
| `AGENT_RDP_PORT` | RDP server port (default: 3389) |
| `AGENT_RDP_USERNAME` | RDP username |
| `AGENT_RDP_PASSWORD` | RDP password |
| `AGENT_RDP_SESSION` | Session name (default: "default") |
| `AGENT_RDP_STREAM_PORT` | WebSocket streaming port (0 = disabled) |
| `AGENT_RDP_STREAM_FPS` | Frame rate for streaming (default: 10) |
| `AGENT_RDP_STREAM_QUALITY` | JPEG quality 0-100 (default: 80) |

## Node.js API

Expand Down
4 changes: 2 additions & 2 deletions crates/agent-rdp/src/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ pub struct ConnectArgs {
#[arg(long, env = "AGENT_RDP_HOST", required = true)]
pub host: String,

/// Server port
#[arg(long, default_value = "3389")]
/// Server port (or set AGENT_RDP_PORT)
#[arg(long, default_value = "3389", env = "AGENT_RDP_PORT")]
pub port: u16,

/// Username (or set AGENT_RDP_USERNAME)
Expand Down
16 changes: 0 additions & 16 deletions docs/WEBSOCKET.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,6 @@ Start a session with the `--stream-port` flag:
agent-rdp --stream-port 9224 connect --host 192.168.1.100 -u Admin -p secret
```

Or use environment variables:

```bash
export AGENT_RDP_STREAM_PORT=9224
export AGENT_RDP_STREAM_FPS=10
export AGENT_RDP_STREAM_QUALITY=80
```

### Accessing the Viewer

The daemon serves both the WebSocket API and an embedded HTML viewer on the same port:
Expand All @@ -42,14 +34,6 @@ You can also use the CLI to open the viewer in your browser:
agent-rdp view --port 9224
```

## Environment Variables

| Variable | Default | Description |
|----------|---------|-------------|
| `AGENT_RDP_STREAM_PORT` | 0 (disabled) | WebSocket server port |
| `AGENT_RDP_STREAM_FPS` | 10 | Frame broadcast rate (frames per second) |
| `AGENT_RDP_STREAM_QUALITY` | 80 | JPEG compression quality (0-100) |

## Message Types

All messages are JSON-encoded text frames.
Expand Down
7 changes: 1 addition & 6 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,4 @@ Browser-based viewer for debugging and interactive control.
- Keyboard input (typing, special keys)
- Fullscreen mode

**Configuration via environment:**
| Variable | Default | Description |
|----------|---------|-------------|
| `AGENT_RDP_STREAM_PORT` | 0 (disabled) | WebSocket server port |
| `AGENT_RDP_STREAM_FPS` | 10 | Frame rate |
| `AGENT_RDP_STREAM_QUALITY` | 80 | JPEG quality (0-100) |
**Enable streaming:** Use `--stream-port` flag when connecting (e.g., `agent-rdp --stream-port 9224 connect ...`).
4 changes: 3 additions & 1 deletion skills/agent-rdp/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,10 +274,12 @@ agent-rdp automate click "#1" # Click Save button
## Environment variables

```bash
export AGENT_RDP_HOST=192.168.1.100
export AGENT_RDP_PORT=3389
export AGENT_RDP_USERNAME=Administrator
export AGENT_RDP_PASSWORD=secret
export AGENT_RDP_SESSION=default
agent-rdp connect --host 192.168.1.100 # Uses env vars for credentials
agent-rdp connect # Uses env vars for connection
```

## Debugging with WebSocket streaming
Expand Down