Skip to content

armgit / cua

Public Imported from GitHub
0

Scale computer-use 2.0 with open-source drivers, cross-OS sandboxes, and benchmarks for training, evaluation, and data generation.

refactor(cua-cli): rename 'open' command to 'vnc' with backwards compatibility

f-trycuaa5f566a5e6f3
diff --git a/docs/content/docs/get-started/quickstart.mdx b/docs/content/docs/get-started/quickstart.mdx
index 25efed737c..088ae3e644 100644
--- a/docs/content/docs/get-started/quickstart.mdx
+++ b/docs/content/docs/get-started/quickstart.mdx
@@ -500,7 +500,7 @@ You can now interact with your sandbox in multiple ways:
#### Option 1: Access VNC Desktop
```bash
-cua sb open my-sandbox-abc123
+cua sb vnc my-sandbox-abc123
```
This opens a remote desktop connection to your sandbox.
diff --git a/docs/content/docs/libraries/cua-cli/commands.mdx b/docs/content/docs/libraries/cua-cli/commands.mdx
index 6e15e3ee99..8abfce92d1 100644
--- a/docs/content/docs/libraries/cua-cli/commands.mdx
+++ b/docs/content/docs/libraries/cua-cli/commands.mdx
@@ -33,7 +33,7 @@ Both styles work identically - use whichever you prefer!
### Available Commands
- **Authentication** - `cua login`, `cua env`, `cua logout`
-- **Sandbox Management** - `cua list`, `cua create`, `cua start`, `cua stop`, `cua restart`, `cua delete`, `cua open`
+- **Sandbox Management** - `cua list`, `cua create`, `cua start`, `cua stop`, `cua restart`, `cua delete`, `cua vnc`
## Authentication Commands
@@ -225,17 +225,20 @@ Sandbox deletion initiated: deleting
This action is irreversible. All data on the sandbox will be permanently lost.
</Callout>
-### `cua open`
+### `cua vnc`
Open the VNC interface for a sandbox in your browser.
```bash
+cua vnc <name>
+
+# Alternative alias
cua open <name>
```
**Example:**
```bash
-$ cua open my-dev-sandbox
+$ cua vnc my-dev-sandbox
Opening NoVNC: https://my-dev-sandbox.containers.cloud.trycua.com/vnc.html?autoconnect=true&password=...
```
@@ -301,8 +304,8 @@ cua env
### 3. Quick Sandbox Access
```bash
# Create aliases for frequently used sandboxes
-alias dev-sandbox="cua open my-development-sandbox"
-alias prod-sandbox="cua open my-production-sandbox"
+alias dev-sandbox="cua vnc my-development-sandbox"
+alias prod-sandbox="cua vnc my-production-sandbox"
```
### 4. Monitoring Provisioning
diff --git a/libs/typescript/cua-cli/README.md b/libs/typescript/cua-cli/README.md
index 34484928c2..9a4b54620c 100644
--- a/libs/typescript/cua-cli/README.md
+++ b/libs/typescript/cua-cli/README.md
@@ -50,7 +50,7 @@ bun run ./index.ts -- --help
- `start <name>` – start a stopped sandbox
- `stop <name>` – stop a running sandbox
- `restart <name>` – restart a sandbox
- - `open <name>` – open NoVNC URL in your browser
+ - `vnc <name>` (alias: `open`) – open VNC desktop in your browser
## Auth Flow (Dynamic Callback Port)
diff --git a/libs/typescript/cua-cli/src/commands/sandbox.ts b/libs/typescript/cua-cli/src/commands/sandbox.ts
index 723865d1ef..c15e9e763a 100644
--- a/libs/typescript/cua-cli/src/commands/sandbox.ts
+++ b/libs/typescript/cua-cli/src/commands/sandbox.ts
@@ -290,8 +290,8 @@ export function registerSandboxCommands(y: Argv) {
restartHandler
)
.command(
- 'open <name>',
- 'Open NoVNC for a sandbox in your browser',
+ ['vnc <name>', 'open <name>'],
+ 'Open VNC desktop for a sandbox',
(y) => y.positional('name', { type: 'string', describe: 'Sandbox name' }),
openHandler
);
@@ -368,8 +368,8 @@ export function registerSandboxCommands(y: Argv) {
restartHandler
)
.command(
- 'open <name>',
- 'Open NoVNC for a sandbox in your browser',
+ ['vnc <name>', 'open <name>'],
+ 'Open VNC desktop for a sandbox',
(y) => y.positional('name', { type: 'string', describe: 'Sandbox name' }),
openHandler
)