Skip to content

docs: make the browser quickstart copy-paste complete #246

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
MagMueller wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: make the browser quickstart copy-paste complete #246

Show file tree
Hide file tree
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
16 changes: 9 additions & 7 deletions docs/cloud/browser/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,21 +34,23 @@ Skip this step if you use curl.

<CodeGroup>
```bash Python
pip install --upgrade browser-use-sdk
pip install --upgrade browser-use-sdk playwright
```
```bash TypeScript
npm install browser-use-sdk@latest
```bash Playwright
npm install browser-use-sdk@latest playwright
```
```bash Puppeteer
npm install browser-use-sdk@latest puppeteer-core
```
</CodeGroup>

## Launch a browser

The browser-management resource currently uses the explicit V3 SDK namespace.
The equivalent REST endpoint is API V4.
The SDK and REST examples use API V4.

<CodeGroup>
```python Python
from browser_use_sdk.v3 import BrowserUse
from browser_use_sdk.v4 import BrowserUse

client = BrowserUse()
browser = client.browsers.create(proxy_country_code="us")
Expand All @@ -58,7 +60,7 @@ print(browser.cdp_url)
client.browsers.stop(browser.id)
```
```typescript TypeScript
import { BrowserUse } from "browser-use-sdk/v3";
import { BrowserUse } from "browser-use-sdk/v4";

const client = new BrowserUse();
const browser = await client.browsers.create({ proxyCountryCode: "us" });
Expand Down
16 changes: 9 additions & 7 deletions docs/cloud/llms-full.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1041,19 +1041,21 @@ export BROWSER_USE_API_KEY=your_key
Skip this step if you use curl.

```bash Python
pip install --upgrade browser-use-sdk
pip install --upgrade browser-use-sdk playwright
```
```bash TypeScript
npm install browser-use-sdk@latest
```bash Playwright
npm install browser-use-sdk@latest playwright
```
```bash Puppeteer
npm install browser-use-sdk@latest puppeteer-core
```

## Launch a browser

The browser-management resource currently uses the explicit V3 SDK namespace.
The equivalent REST endpoint is API V4.
The SDK and REST examples use API V4.

```python Python
from browser_use_sdk.v3 import BrowserUse
from browser_use_sdk.v4 import BrowserUse

client = BrowserUse()
browser = client.browsers.create(proxy_country_code="us")
Expand All @@ -1063,7 +1065,7 @@ print(browser.cdp_url)
client.browsers.stop(browser.id)
```
```typescript TypeScript
import { BrowserUse } from "browser-use-sdk/v3";
import { BrowserUse } from "browser-use-sdk/v4";

const client = new BrowserUse();
const browser = await client.browsers.create({ proxyCountryCode: "us" });
Expand Down
16 changes: 9 additions & 7 deletions docs/llms-full.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1041,19 +1041,21 @@ export BROWSER_USE_API_KEY=your_key
Skip this step if you use curl.

```bash Python
pip install --upgrade browser-use-sdk
pip install --upgrade browser-use-sdk playwright
```
```bash TypeScript
npm install browser-use-sdk@latest
```bash Playwright
npm install browser-use-sdk@latest playwright
```
```bash Puppeteer
npm install browser-use-sdk@latest puppeteer-core
```

## Launch a browser

The browser-management resource currently uses the explicit V3 SDK namespace.
The equivalent REST endpoint is API V4.
The SDK and REST examples use API V4.

```python Python
from browser_use_sdk.v3 import BrowserUse
from browser_use_sdk.v4 import BrowserUse

client = BrowserUse()
browser = client.browsers.create(proxy_country_code="us")
Expand All @@ -1063,7 +1065,7 @@ print(browser.cdp_url)
client.browsers.stop(browser.id)
```
```typescript TypeScript
import { BrowserUse } from "browser-use-sdk/v3";
import { BrowserUse } from "browser-use-sdk/v4";

const client = new BrowserUse();
const browser = await client.browsers.create({ proxyCountryCode: "us" });
Expand Down