Local Setup
Set up Browser Use development environment locally
Welcome to Browser Use Development!
We’re excited to have you join our community of contributors. This guide will help you set up your local development environment quickly and easily.
Quick Setup
If you’re familiar with Python development, here’s the quick way to get started:
Helper Scripts
We provide several convenient shell scripts in the bin/
directory to help with common development tasks:
Prerequisites
Browser Use requires Python 3.11 or higher. We recommend using uv for Python environment management.
Detailed Setup Instructions
Clone the Repository
First, clone the Browser Use repository:
Environment Setup
- Create and activate a virtual environment:
- Install dependencies:
Configuration
Set up your environment variables:
Or manually create a .env
file with the API key for the models you want to use set:
You can use any LLM model supported by LangChain. See LangChain Models for available options and their specific API key requirements.
Development
After setup, you can:
- Try demos in the example library with
uv run examples/simple.py
- Run the linter/formatter with
uv run ruff format examples/some/file.py
- Run tests with
uv run pytest
- Build the package with
uv build
Linting
Tests
Build
Getting Help
If you run into any issues:
- Check our GitHub Issues
- Join our Discord community for support
We welcome contributions! See our Contribution Guide for guidelines on how to help improve Browser Use.