Skip to content

quickstart.md

Latest commit

 

History

History
70 lines (52 loc) · 3.02 KB

quickstart.md

File metadata and controls

70 lines (52 loc) · 3.02 KB
Raw

Browser Use, built on Pi

A TypeScript SDK. The agent writes JavaScript, sees Chrome’s accessibility tree, and uses raw CDP. Pi supplies the model loop. Browser Use Pi adds the browser and a persistent session.

Install

Run your app with Node 22.19+ or Bun 1.3.14+. Bun also requires Node on PATH: the persistent JavaScript worker uses Node’s V8 inspector. Set BROWSER_USE_NODE=/absolute/path/to/node to choose that executable. The worker does not inherit host preload flags or API keys.

Use local Chrome or Browser Use Cloud. Runtime checks cover macOS; Windows has not been verified. The SDK requires a Node process and filesystem, so it does not run directly inside Cloudflare Workers. A remote browser does not remove that runtime requirement.

npm install @browser_use/pi
# or: pnpm add @browser_use/pi
# or: bun add @browser_use/pi
export OPENROUTER_API_KEY=...
export BROWSER_USE_API_KEY=...

Run

Save as agent.ts:

import { Browser, BrowserUse } from '@browser_use/pi';

const agent = await BrowserUse.create({
  model: 'openrouter/openai/gpt-5.6-luna',
  reasoning: 'xhigh',
  browser: Browser.cloud({ apiKey: process.env.BROWSER_USE_API_KEY! }),
  workspace: './work',
  log: 'pretty',
});
try {
  const result = await agent.run('Find the top story on Hacker News.');
  console.log(result.status, result.text);
  await agent.followUp('Summarize the comments.');
} finally {
  await agent.close();
}
node agent.ts
# or
bun agent.ts

completed means the agent delivered a schema-valid answer. Verify business outcomes in your application. Other statuses describe the stop reason; always check them.

Use models for credentials, sessions for login and persistence, and API for output, events and hooks.

Moving from @browser_use/js

Install @browser_use/pi and change your imports. The BrowserUse API, browser options, environment variables, profile directories and session history format are unchanged. The earlier package remains available; this rename does not migrate or delete existing data.

Publish to npm (maintainers)

The public package is @browser_use/pi. Use an npm account with publish permission in the browser_use organization and complete npm's required 2FA setup.

npm login
npm whoami
npm run check && npm test && npm run test:bun
npm pack
npm publish ./browser_use-pi-0.1.0.tgz --access public --dry-run
# After verifying that exact tarball:
npm publish ./browser_use-pi-0.1.0.tgz --access public

npm test runs the full Node suite. npm run test:bun runs browser, agent, session, policy, recording and recovery tests in Bun; Node-specific test mocks stay in the Node suite. Install and smoke-test the tarball in a clean project before publishing. npm versions cannot be overwritten; bump the version for each later release. For automated releases, configure npm trusted publishing for the final GitHub repository name. No npm token needs to live in this repository.