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.

feat(cua-cli): improve command descriptions for better clarity

f-trycua27f6d448ea47
diff --git a/libs/typescript/cua-cli/src/cli.ts b/libs/typescript/cua-cli/src/cli.ts
index 60d68698a6..6d00ffd298 100644
--- a/libs/typescript/cua-cli/src/cli.ts
+++ b/libs/typescript/cua-cli/src/cli.ts
@@ -8,11 +8,19 @@ export async function runCli() {
.scriptName('cua')
.usage('Usage: $0 <command> [options]')
.epilogue(
- 'Grouped Commands (recommended):\n' +
- ' cua auth <command> Manage authentication (login, env, logout)\n' +
- ' cua sb <command> Manage sandboxes (list, create, start, stop, etc.)\n' +
+ 'Recommended Command Structure:\n' +
+ ' cua auth <command> Authenticate and manage credentials\n' +
+ ' login Login via browser or with API key\n' +
+ ' env Export API key to .env file\n' +
+ ' logout Clear stored credentials\n' +
'\n' +
- 'For more information: https://docs.cua.ai/libraries/cua-cli/commands'
+ ' cua sb <command> Create and manage cloud sandboxes\n' +
+ ' list View all your sandboxes\n' +
+ ' create Provision a new sandbox\n' +
+ ' start/stop Control sandbox state\n' +
+ ' vnc Open remote desktop\n' +
+ '\n' +
+ 'Documentation: https://docs.cua.ai/libraries/cua-cli/commands'
);
argv = registerAuthCommands(argv);
argv = registerSandboxCommands(argv);
diff --git a/libs/typescript/cua-cli/src/commands/auth.ts b/libs/typescript/cua-cli/src/commands/auth.ts
index 18c9cc85ab..71a9e21b54 100644
--- a/libs/typescript/cua-cli/src/commands/auth.ts
+++ b/libs/typescript/cua-cli/src/commands/auth.ts
@@ -58,12 +58,12 @@ export function registerAuthCommands(y: Argv) {
// Grouped structure: cua auth <command>
y.command(
'auth',
- 'Manage authentication',
+ 'Authenticate with CUA (login, logout, or export credentials)',
(y) => {
return y
.command(
'login',
- 'Open browser to authorize and store API key',
+ 'Authenticate via browser or API key and save credentials locally',
(y) =>
y.option('api-key', {
type: 'string',
@@ -73,11 +73,11 @@ export function registerAuthCommands(y: Argv) {
)
.command(
'env',
- 'Create or update .env with CUA_API_KEY (login if needed)',
+ 'Export your API key to a .env file in the current directory',
() => {},
envHandler
)
- .command('logout', 'Remove stored API key', () => {}, logoutHandler)
+ .command('logout', 'Clear stored API credentials from this machine', () => {}, logoutHandler)
.demandCommand(1, 'You must provide an auth command');
},
() => {}
diff --git a/libs/typescript/cua-cli/src/commands/sandbox.ts b/libs/typescript/cua-cli/src/commands/sandbox.ts
index 04e3c3d517..8d288bb3c7 100644
--- a/libs/typescript/cua-cli/src/commands/sandbox.ts
+++ b/libs/typescript/cua-cli/src/commands/sandbox.ts
@@ -306,12 +306,12 @@ export function registerSandboxCommands(y: Argv) {
// Grouped structure: cua sandbox <command> or cua sb <command>
y.command(
['sandbox', 'sb'],
- 'Manage sandboxes',
+ 'Create and manage cloud sandboxes (Linux, Windows, or macOS)',
(y) => {
return y
.command(
['list', 'ls', 'ps'],
- 'List sandboxes',
+ 'List all your sandboxes with status and connection details',
(y) =>
y.option('show-passwords', {
type: 'boolean',
@@ -322,7 +322,7 @@ export function registerSandboxCommands(y: Argv) {
)
.command(
'create',
- 'Create a new sandbox',
+ 'Provision a new cloud sandbox in your chosen OS, size, and region',
(y) =>
y
.option('os', {
@@ -352,31 +352,31 @@ export function registerSandboxCommands(y: Argv) {
)
.command(
'delete <name>',
- 'Delete a sandbox',
+ 'Permanently delete a sandbox and all its data',
(y) => y.positional('name', { type: 'string', describe: 'Sandbox name' }),
deleteHandler
)
.command(
'start <name>',
- 'Start a sandbox',
+ 'Start a stopped sandbox',
(y) => y.positional('name', { type: 'string', describe: 'Sandbox name' }),
startHandler
)
.command(
'stop <name>',
- 'Stop a sandbox',
+ 'Stop a running sandbox (data is preserved)',
(y) => y.positional('name', { type: 'string', describe: 'Sandbox name' }),
stopHandler
)
.command(
'restart <name>',
- 'Restart a sandbox',
+ 'Restart a sandbox (reboot the system)',
(y) => y.positional('name', { type: 'string', describe: 'Sandbox name' }),
restartHandler
)
.command(
['vnc <name>', 'open <name>'],
- 'Open VNC desktop for a sandbox',
+ 'Open remote desktop (VNC) connection in your browser',
(y) => y.positional('name', { type: 'string', describe: 'Sandbox name' }),
openHandler
)