@rmbk/compeek 0.2.5 → 0.2.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -12
- package/bin/compeek.mjs +5 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
### Option 1: One command (recommended)
|
|
25
25
|
|
|
26
26
|
```bash
|
|
27
|
-
npx @rmbk/compeek start --open
|
|
27
|
+
npx @rmbk/compeek@latest start --open
|
|
28
28
|
```
|
|
29
29
|
|
|
30
30
|
This downloads a virtual desktop, starts it, and opens the dashboard in your browser.
|
|
@@ -58,7 +58,7 @@ The agent loop runs in the browser via `@anthropic-ai/sdk` with `dangerouslyAllo
|
|
|
58
58
|
It uses `computer_20250124`, `bash_20250124`, and `text_editor_20250728` tools.
|
|
59
59
|
Extended thinking is enabled with a 10240 token budget.
|
|
60
60
|
|
|
61
|
-
Each container runs Ubuntu 24.04 with Xvfb (
|
|
61
|
+
Each container runs Ubuntu 24.04 with Xvfb (1280x768), XFWM4, x11vnc, noVNC, and Firefox (with uBlock Origin).
|
|
62
62
|
The container exposes a minimal Express tool server with endpoints:
|
|
63
63
|
`GET /api/health`, `GET /api/info`, `POST /api/tool`, `POST /api/bash`.
|
|
64
64
|
|
|
@@ -78,7 +78,7 @@ Set `DESKTOP_MODE` when starting a container:
|
|
|
78
78
|
| `headless` | No visual — commands only | Automated scripts |
|
|
79
79
|
|
|
80
80
|
```bash
|
|
81
|
-
npx @rmbk/compeek start --mode browser
|
|
81
|
+
npx @rmbk/compeek@latest start --mode browser
|
|
82
82
|
# or
|
|
83
83
|
docker run -d -e DESKTOP_MODE=browser -p 3001:3000 -p 6081:6080 --shm-size=512m ghcr.io/uburuntu/compeek
|
|
84
84
|
```
|
|
@@ -100,13 +100,13 @@ Three ways to connect:
|
|
|
100
100
|
## CLI
|
|
101
101
|
|
|
102
102
|
```bash
|
|
103
|
-
npx @rmbk/compeek start # Pull image, start container, print connection info
|
|
104
|
-
npx @rmbk/compeek start --open # Same + open dashboard in browser
|
|
105
|
-
npx @rmbk/compeek stop # Stop all compeek containers
|
|
106
|
-
npx @rmbk/compeek stop 1 # Stop compeek-1
|
|
107
|
-
npx @rmbk/compeek status # List running containers
|
|
108
|
-
npx @rmbk/compeek logs # Follow container logs
|
|
109
|
-
npx @rmbk/compeek open # Open dashboard with auto-connect URL
|
|
103
|
+
npx @rmbk/compeek@latest start # Pull image, start container, print connection info
|
|
104
|
+
npx @rmbk/compeek@latest start --open # Same + open dashboard in browser
|
|
105
|
+
npx @rmbk/compeek@latest stop # Stop all compeek containers
|
|
106
|
+
npx @rmbk/compeek@latest stop 1 # Stop compeek-1
|
|
107
|
+
npx @rmbk/compeek@latest status # List running containers
|
|
108
|
+
npx @rmbk/compeek@latest logs # Follow container logs
|
|
109
|
+
npx @rmbk/compeek@latest open # Open dashboard with auto-connect URL
|
|
110
110
|
```
|
|
111
111
|
|
|
112
112
|
Flags for `start`: `--name`, `--api-port`, `--vnc-port`, `--mode`, `--persist`, `--password`, `--tunnel`, `--no-pull`, `--open`.
|
|
@@ -126,7 +126,7 @@ Each container auto-generates a **VNC password** on startup. The password is inc
|
|
|
126
126
|
You can set your own password with `--password`:
|
|
127
127
|
|
|
128
128
|
```bash
|
|
129
|
-
npx @rmbk/compeek start --password mysecret
|
|
129
|
+
npx @rmbk/compeek@latest start --password mysecret
|
|
130
130
|
```
|
|
131
131
|
|
|
132
132
|
### Remote access
|
|
@@ -136,7 +136,7 @@ If you're running compeek on the same machine as your browser, everything works
|
|
|
136
136
|
To access a container from another machine (e.g. a remote server), use `--tunnel` to create public URLs:
|
|
137
137
|
|
|
138
138
|
```bash
|
|
139
|
-
npx @rmbk/compeek start --tunnel
|
|
139
|
+
npx @rmbk/compeek@latest start --tunnel
|
|
140
140
|
```
|
|
141
141
|
|
|
142
142
|
This uses [localtunnel](https://theboroer.github.io/localtunnel-www/) to make the container reachable over the internet. The VNC desktop is password-protected, but the tool API currently has no authentication — use a VPN or firewall for sensitive environments.
|
package/bin/compeek.mjs
CHANGED
|
@@ -496,10 +496,10 @@ async function cmdStart(args) {
|
|
|
496
496
|
console.log(` ${c.dim}Streamable HTTP${c.reset} ${tunnel.apiUrl}/mcp`);
|
|
497
497
|
}
|
|
498
498
|
console.log(` ${c.dim}Local MCP${c.reset} http://localhost:${apiPort}/mcp`);
|
|
499
|
-
console.log(` ${c.dim}stdio proxy${c.reset} npx @rmbk/compeek mcp`);
|
|
499
|
+
console.log(` ${c.dim}stdio proxy${c.reset} npx @rmbk/compeek@latest mcp`);
|
|
500
500
|
console.log('');
|
|
501
501
|
console.log(` ${c.dim}Claude Code config (~/.claude/settings.json):${c.reset}`);
|
|
502
|
-
console.log(` ${c.dim}{ "mcpServers": { "compeek": { "command": "npx", "args": ["-y", "@rmbk/compeek", "mcp"] } } }${c.reset}`);
|
|
502
|
+
console.log(` ${c.dim}{ "mcpServers": { "compeek": { "command": "npx", "args": ["-y", "@rmbk/compeek@latest", "mcp"] } } }${c.reset}`);
|
|
503
503
|
console.log('');
|
|
504
504
|
|
|
505
505
|
if (flags.open) {
|
|
@@ -626,8 +626,8 @@ async function cmdMcp(args) {
|
|
|
626
626
|
process.stderr.write(`Container ${name} ready at ${containerUrl}\n`);
|
|
627
627
|
} else {
|
|
628
628
|
process.stderr.write('No running compeek container found.\n');
|
|
629
|
-
process.stderr.write('Start one with: npx @rmbk/compeek start\n');
|
|
630
|
-
process.stderr.write('Or use: npx @rmbk/compeek mcp --start\n');
|
|
629
|
+
process.stderr.write('Start one with: npx @rmbk/compeek@latest start\n');
|
|
630
|
+
process.stderr.write('Or use: npx @rmbk/compeek@latest mcp --start\n');
|
|
631
631
|
process.exit(1);
|
|
632
632
|
}
|
|
633
633
|
}
|
|
@@ -752,7 +752,7 @@ switch (command) {
|
|
|
752
752
|
console.log(`
|
|
753
753
|
${c.bold}${c.cyan}compeek${c.reset} ${c.dim}— AI eyes & hands for any desktop${c.reset}
|
|
754
754
|
|
|
755
|
-
${c.bold}Usage${c.reset} npx @rmbk/compeek ${c.dim}[command] [options]${c.reset}
|
|
755
|
+
${c.bold}Usage${c.reset} npx @rmbk/compeek@latest ${c.dim}[command] [options]${c.reset}
|
|
756
756
|
|
|
757
757
|
${c.bold}Commands${c.reset}
|
|
758
758
|
start ${c.dim}............${c.reset} Start a new virtual desktop ${c.dim}(default)${c.reset}
|
package/package.json
CHANGED