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

Rename the VNC command from 'open' to 'vnc' for clarity and specificity.
Keep 'open' as an alias for backwards compatibility.

Changes:
- Update command definition to use 'vnc' as primary, 'open' as alias
- Update README.md to reflect new command name
- Update commands.mdx documentation with new command and alias
- Update quickstart.mdx to use 'cua sb vnc'
- Update command examples in tips section

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
f-trycua
2025-11-18 13:30:34 +01:00
parent c6eb4477c6
commit a5f566a5e6
4 changed files with 14 additions and 11 deletions

View File

@@ -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.

View File

@@ -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

View File

@@ -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)

View File

@@ -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
)