From a5f566a5e6f341fdfbd0ec182ccf924c8000b618 Mon Sep 17 00:00:00 2001 From: f-trycua Date: Tue, 18 Nov 2025 13:30:34 +0100 Subject: [PATCH] refactor(cua-cli): rename 'open' command to 'vnc' with backwards compatibility MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- docs/content/docs/get-started/quickstart.mdx | 2 +- docs/content/docs/libraries/cua-cli/commands.mdx | 13 ++++++++----- libs/typescript/cua-cli/README.md | 2 +- libs/typescript/cua-cli/src/commands/sandbox.ts | 8 ++++---- 4 files changed, 14 insertions(+), 11 deletions(-) diff --git a/docs/content/docs/get-started/quickstart.mdx b/docs/content/docs/get-started/quickstart.mdx index 25efed73..088ae3e6 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 6e15e3ee..8abfce92 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. -### `cua open` +### `cua vnc` Open the VNC interface for a sandbox in your browser. ```bash +cua vnc + +# Alternative alias cua open ``` **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 34484928..9a4b5462 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 ` – start a stopped sandbox - `stop ` – stop a running sandbox - `restart ` – restart a sandbox - - `open ` – open NoVNC URL in your browser + - `vnc ` (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 723865d1..c15e9e76 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 ', - 'Open NoVNC for a sandbox in your browser', + ['vnc ', 'open '], + '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 ', - 'Open NoVNC for a sandbox in your browser', + ['vnc ', 'open '], + 'Open VNC desktop for a sandbox', (y) => y.positional('name', { type: 'string', describe: 'Sandbox name' }), openHandler )