Browser automation powered by LLMs in JavaScript/TypeScript.
⚠️ IMPORTANT NOTE ⚠️
This library is currently under heavy development and NOT READY FOR PRODUCTION USE. The API is unstable and subject to major changes.
If you'd like to help develop this library, please check out port-diff.md which outlines the current development priorities and areas where help is needed.
browser-use-node
is a powerful library that combines browser automation capabilities with Large Language Models (LLMs) to create intelligent browser interactions. Built on top of Playwright and LangChain, it provides a seamless way to automate browser tasks with AI assistance.
This is a JavaScript/TypeScript port of the original browser-use Python library.
This project is based on browser-use, originally created by:
We are grateful for their pioneering work in browser automation with LLMs.
⚠️ Note: These instructions are for development purposes only. The library is not yet ready for production use.
The package is available on npm for experimental purposes:
# ⚠️ Not recommended for production use npm install browser-use-node
Note: While the package is available on npm as
browser-use-node
, it's currently intended for exploration only. The API is unstable and will undergo significant changes. For development and contributions, please use the development setup below.
Clone the repository:
git clone https://github.com/browser-use/browser-use-node.git cd browser-use-node
Install dependencies:
bun install
Set up environment variables:
cp .env.example .env
Edit .env
and add your API keys and configuration:
OPENAI_API_KEY
- Required for LLM functionalityThe examples/
directory contains sample scripts demonstrating various features:
bun run examples/amazon-search.ts
⚠️ These are development tests. The test suite is still being expanded.
# Run all tests bun test # Run specific test suite bun test --grep "Browser" # Run tests in watch mode bun test --watch
When contributing new features or fixes:
tests/
directorytests/utils/
For development debugging:
DEBUG
environment variable:
DEBUG=browser-use* bun test
.vscode/launch.json
Bun is used as the primary runtime because it provides:
# Building bun run build # Build the project bun run build:binary # Build as native binary bun run build:examples # Build example files bun run clean # Clean build artifacts # Development bun run type-check # Run TypeScript type checking bun run format # Format code with Prettier bun run lint # Run ESLint # Examples bun run example:amazon # Run Amazon search example bun run example:multi-tab # Run multi-tab example bun run example:simple # Run simple example # Testing bun run test # Run all tests bun run test:smoke # Run smoke tests
The project generates these outputs in the dist
directory:
Start with an example:
bun run example:simple
This helps verify your setup is working.
Before committing:
bun run type-check # Check types bun run format # Format code bun run lint # Check for issues bun run test # Run tests
The project supports various environment configurations:
# Required OPENAI_API_KEY=your_key_here # Optional DEBUG=browser-use* # Enable debug logging HEADLESS=false # Run browsers in headed mode
For the best development experience:
VSCode Extensions:
Recommended VSCode settings are provided in .vscode/settings.json
Browser Debugging:
# Run with browser debugging enabled DEBUG=browser-use* HEADLESS=false bun run example:simple
Test Debugging:
# Run tests with debug output DEBUG=browser-use* bun test
build:binary
option for maximum performance and maximum risksThe project uses Docusaurus for documentation and TypeDoc for API reference.
# Start development server bun run docs:dev # Build documentation bun run docs:build # Serve built documentation bun run docs:serve # Generate API documentation bun run docs:generate-api
/docs/
- Main documentation site
/docs/intro
- Getting started guide/docs/guides
- Usage guides and tutorials/docs/api
- Auto-generated API documentation/docs/examples
- Example usage and code snippetsWe welcome contributions! Please see our Contributing Guidelines for details on how to get started and our development process. By participating in this project, you agree to abide by our Code of Conduct.
We take security seriously. If you discover a security vulnerability, please follow our Security Policy for responsible disclosure.
Add Package
npx jsr add @browser-use/browser-use-node
Import symbol
import * as browser_use_node from "@browser-use/browser-use-node";
Add Package
yarn dlx jsr add @browser-use/browser-use-node
Import symbol
import * as browser_use_node from "@browser-use/browser-use-node";
Add Package
pnpm dlx jsr add @browser-use/browser-use-node
Import symbol
import * as browser_use_node from "@browser-use/browser-use-node";
Add Package
bunx jsr add @browser-use/browser-use-node
Import symbol
import * as browser_use_node from "@browser-use/browser-use-node";