Skip to content

docs(computer-sdk): clarify TypeScript host desktop support #1027

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
BloggerBust wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(computer-sdk): clarify TypeScript host desktop support #1027

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 5 additions & 12 deletions docs/content/docs/cua/guide/get-started/using-computer-sdk.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,19 +321,12 @@ The Computer SDK lets you connect to your sandbox and perform basic interactions
```
</Tab>
<Tab value="Your host desktop">
First, install and run `cua-computer-server`:
```bash
pip install cua-computer-server
python -m computer_server
```
<Callout type="info" title="Host desktop support (TypeScript)">
Connecting to a local host desktop is currently supported in **Python only** via `cua-computer-server`.
The TypeScript SDK does not yet support host desktop connections.

Then, use the `Computer` object to connect:
```typescript
import { Computer } from '@trycua/computer';

const computer = new Computer({ useHostComputerServer: true });
await computer.run(); // Connect to the host desktop
```
Feature parity is planned (see [#916](https://github.com/trycua/cua/issues/916)).
</Callout>
</Tab>
</Tabs>

Expand Down