Previously, users had to explicitly read the CUA_API_KEY environment variable
and pass it to the Computer/CloudProvider constructor. This change makes the
API key parameter optional and automatically reads from the CUA_API_KEY
environment variable if not provided.
Changes:
- CloudProvider.__init__: Made api_key parameter optional, reads from CUA_API_KEY env var
- Computer.__init__: Added fallback to CUA_API_KEY env var for api_key parameter
- Updated documentation examples to show simplified usage without explicit api_key
- Updated cloud_api_examples.py to demonstrate the new simpler pattern
This provides a cleaner API while maintaining backward compatibility with
explicit api_key parameter passing.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
hud-python is an external package that isn't published to PyPI yet,
which was blocking installation of cua-agent[all]. This change:
- Removes hud-python==0.4.52 from the [all] extra dependencies
- Keeps the separate [hud] extra for users who have access to hud-python
- Allows pip install cua-agent[all] to work without dependency errors
The hud functionality remains available as an opt-in extra via:
pip install cua-agent[hud]
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
- Add introducing-cua-cli.md blog post following the Windows/macOS announcement style
- Update CLI sandbox command to use sandbox.cua.ai domain instead of containers.cloud.trycua.com
- Update all documentation references to use new sandbox.cua.ai domain
- Maintain consistency with Python SDK which already uses sandbox.cua.ai
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
- Register grouped commands (auth, sandbox/sb) first so they appear at top of help
- Hide flat commands from help using describe: false while maintaining functionality
- Fix remaining --configuration references in docs (should be --size)
- Improves help clarity by showing recommended command structure prominently
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
Enhance help text throughout the CLI to make commands more discoverable
and their purposes clearer. Better descriptions help users understand
what each command does without consulting documentation.
Changes:
- Update main command descriptions:
- 'cua auth': "Authenticate with CUA (login, logout, or export credentials)"
- 'cua sb': "Create and manage cloud sandboxes (Linux, Windows, or macOS)"
- Improve auth subcommand descriptions:
- login: "Authenticate via browser or API key and save credentials locally"
- env: "Export your API key to a .env file in the current directory"
- logout: "Clear stored API credentials from this machine"
- Enhance sandbox subcommand descriptions:
- list: "List all your sandboxes with status and connection details"
- create: "Provision a new cloud sandbox in your chosen OS, size, and region"
- delete: "Permanently delete a sandbox and all its data"
- start: "Start a stopped sandbox"
- stop: "Stop a running sandbox (data is preserved)"
- restart: "Restart a sandbox (reboot the system)"
- vnc: "Open remote desktop (VNC) connection in your browser"
- Expand epilogue to show command hierarchy with examples
- Replace generic descriptions with action-oriented, specific language
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
Add epilogue to help output that clarifies the recommended command structure
(grouped commands like 'cua auth' and 'cua sb'). While flat commands remain
available for backwards compatibility, the help now clearly guides users toward
the more organized grouped command style.
Changes:
- Add usage and epilogue text to cli.ts explaining grouped command structure
- Mark flat commands as hidden (though yargs doesn't fully respect this for top-level commands)
- Add type annotations to command builders to fix TypeScript errors
- Epilogue shows recommended patterns: 'cua auth <command>' and 'cua sb <command>'
- Include docs link for more information
The help output now clearly distinguishes between available commands and
recommended command patterns, reducing confusion while maintaining full
backwards compatibility.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
Add support for grouped auth command structure (cua auth login/env/logout)
while maintaining backwards compatibility with flat commands (cua login/env/logout).
Update all documentation to prefer the more explicit grouped style.
Changes:
- Refactor auth.ts to support both flat and grouped command structures
- Extract auth command handlers for reuse (loginHandler, envHandler, logoutHandler)
- Add "cua auth" command group with login/env/logout subcommands
- Update quickstart to use "cua auth login" instead of "cua login"
- Update CLI index.mdx and installation.mdx to use grouped style
- Update commands.mdx to show grouped style as primary with flat as alternative
- Update README.md to document both command styles
- Update error messages and examples to use grouped style
Both command styles work identically - users can choose based on preference.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
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>
Update documentation and examples to showcase the 'cua sb' shorthand as
the primary grouped command style, since it's more concise than
'cua sandbox'.
Changes:
- CLI index docs: Use `cua sb` in examples
- Command reference: Show `cua sb` first, then `cua sandbox` as alternative
- Quickstart guide: All sandbox commands now use `cua sb`
- README: Reorder to show `cua sb` as primary grouped style
Auth commands remain flat: `cua login`, `cua env`, `cua logout`
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
The option `--size` is much more intuitive than `--configuration` when
the values are small/medium/large.
Changes:
- CLI option renamed from `--configuration` to `--size`
- API still receives `configuration` parameter (internal mapping)
- Updated all documentation to use `--size`
- Updated examples in README, docs, and quickstart
Users now use:
- `cua create --os linux --size small --region north-america`
Instead of:
- `cua create --os linux --configuration small --region north-america`
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
Support both flat (`cua list`) and grouped (`cua sandbox list` or `cua sb list`)
command styles for maximum flexibility.
Key changes:
- Extracted command handlers to be reusable
- Register each command in both flat and grouped structures
- Add `sb` as shorthand alias for `sandbox`
- Update documentation to show both styles
Users can now use:
- Flat: `cua list`, `cua create`, `cua start <name>`
- Grouped: `cua sandbox list`, `cua sandbox create`, `cua sandbox start <name>`
- Shorthand: `cua sb list`, `cua sb create`, `cua sb start <name>`
All three styles work identically!
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
Remove environment override sections that referenced staging deployments
from both the README and documentation. Users should only interact with
production environments.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
