Open-source Python library for AI browser agents, plus Browser Use Cloud: stealth browsers and a hosted agent API.
Python ai-agentsai-toolsbrowser-agentbrowser-automationbrowser-usecdpcloud-browsercomputer-useheadless-browserllmmcpplaywrightpythonremote-browserstealth-browserweb-automationweb-scraping
update-local-dev-docs
Magnus Müller14468d021f0e
diff --git a/.env.example b/.env.exampleindex ef0fe4736..e227a98ea 100644--- a/.env.example+++ b/.env.example@@ -33,6 +33,12 @@ ANONYMIZED_TELEMETRY=true# Default LLM model to use# OPENAI_API_KEY=your_openai_api_key_here# ANTHROPIC_API_KEY=your_anthropic_api_key_here+# AZURE_OPENAI_API_KEY=+# AZURE_ENDPOINT=+# GOOGLE_API_KEY=+# DEEPSEEK_API_KEY=+# GROK_API_KEY=+# NOVITA_API_KEY=# Browser Configuration# Path to Chrome/Chromium executable (optional)diff --git a/docs/development/contribution-guide.mdx b/docs/development/contribution-guide.mdxindex 4fb182bf9..cbc91ab4e 100644--- a/docs/development/contribution-guide.mdx+++ b/docs/development/contribution-guide.mdx@@ -5,68 +5,35 @@ icon: "github"mode: "wide"----# Join the Browser Use Community!+## Mission-We're thrilled you're interested in contributing to Browser Use! This guide will help you get started with contributing to our project. Your contributions are what make the open-source community such an amazing place to learn, inspire, and create.+- Make developers happy+- Do more clicks than human+- Tell your computer what to do, and it gets it done.+- Make agents faster and more reliable.-## Quick Setup-Get started with Browser Use development in minutes:+## What to work on?-```bash-git clone https://github.com/browser-use/browser-use-cd browser-use-uv sync --all-extras --dev-# or pip install -U git+https://github.com/browser-use/browser-use.git@main+- This space is moving fast. We have 10 ideas daily. Lets exchange some.+- Browse our [GitHub Issues](https://github.com/browser-use/browser-use/issues)+- Check out our most active issues on [Discord](https://discord.gg/zXJJHtJf3k)+- Get inspiration in [`#showcase-your-work`](https://discord.com/channels/1303749220842340412/1305549200678850642) channel+- Explore [`awesome-browser-use-prompts`](https://github.com/browser-use/awesome-prompts)!-echo "BROWSER_USE_LOGGING_LEVEL=debug" >> .env-```-For more detailed setup instructions, see our [Local Setup Guide](/development/local-setup).+## What makes a great pull request?-## How to Contribute+1. Why do we need this PR?+2. Include a demo screenshot/gif+3. Make sure the PR passes all CI tests+4. Keep your PR focused on a single feature-### Find Something to Work On--- Browse our [GitHub Issues](https://github.com/browser-use/browser-use/issues) for beginner-friendly issues labeled `good-first-issue`-- Check out our most active issues or ask in [Discord](https://discord.gg/zXJJHtJf3k) for ideas of what to work on-- Get inspiration and share what you build in the [`#showcase-your-work`](https://discord.com/channels/1303749220842340412/1305549200678850642) channel-- Explore or contribute to [`awesome-browser-use-prompts`](https://github.com/browser-use/awesome-prompts)!--### Making a Great Pull Request--When submitting a pull request, please:--- Include a clear description of what the PR does and why it's needed-- Add tests that cover your changes-- Include a demo screenshot/gif or an example script demonstrating your changes-- Make sure the PR passes all CI checks and tests-- Keep your PR focused on a single issue or feature to make it easier to review--Note: We appreciate quality over quantity. Instead of submitting small typo/style-only PRs, consider including those fixes as part of larger bugfix or feature PRs.--### Contribution Process+## Contribution Process1. Fork the repository2. Create a new branch for your feature or bugfix-3. Make your changes-4. Run tests to ensure everything works-5. Submit a pull request-6. Respond to any feedback from maintainers-7. Celebrate your contribution!--Feel free to bump your issues/PRs with comments periodically if you need faster feedback.--## Code of Conduct--We're committed to providing a welcoming and inclusive environment for all contributors. Please be respectful and constructive in all interactions.--## Getting Help--If you need help at any point:+3. Submit a pull request-- Join our [Discord community](https://link.browser-use.com/discord)-- Ask questions in the appropriate GitHub issue-- Check our [documentation](/introduction)+We are overwhelmed with Issues and PRs. Feel free to bump your issues/PRs with comments periodically if you need faster feedback.-We're here to help you succeed in contributing to Browser Use!diff --git a/docs/development/local-setup.mdx b/docs/development/local-setup.mdxindex 43f4f349f..bb3b4f384 100644--- a/docs/development/local-setup.mdx+++ b/docs/development/local-setup.mdx@@ -1,74 +1,18 @@---title: "Local Setup"-description: "Set up Browser Use development environment locally"+description: "We're excited to have you join our community of contributors. "icon: "laptop-code"mode: "wide"----# Welcome to Browser Use Development!+## 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:```bashgit clone https://github.com/browser-use/browser-usecd browser-useuv sync --all-extras --dev# or pip install -U git+https://github.com/browser-use/browser-use.git@main--echo "BROWSER_USE_LOGGING_LEVEL=debug" >> .env-```--## Helper Scripts--We provide several convenient shell scripts in the `bin/` directory to help with common development tasks:--```bash-# Complete setup script - installs uv, creates a venv, and installs dependencies-./bin/setup.sh--# Run all pre-commit hooks (formatting, linting, type checking)-./bin/lint.sh--# Run the core test suite that's executed in CI-./bin/test.sh-```--## Prerequisites--Browser Use requires Python 3.11 or higher. We recommend using [uv](https://docs.astral.sh/uv/) for Python environment management.--## Detailed Setup Instructions--### Clone the Repository--First, clone the Browser Use repository:--```bash-git clone https://github.com/browser-use/browser-use-cd browser-use-```--### Environment Setup--1. Create and activate a virtual environment:--```bash-uv venv --python 3.11-source .venv/bin/activate-```--2. Install dependencies:--```bash-# Install the package in editable mode with all development dependencies-uv sync --all-extras--# Install the default browser-playwright install chromium --with-deps --no-shell```## Configuration@@ -78,83 +22,38 @@ Set up your environment variables:```bash# Copy the example environment filecp .env.example .env-```-Or manually create a `.env` file with the API key for the models you want to use set:--```bash .env-OPENAI_API_KEY=...-ANTHROPIC_API_KEY=-AZURE_ENDPOINT=-AZURE_OPENAI_API_KEY=-GOOGLE_API_KEY=-DEEPSEEK_API_KEY=-GROK_API_KEY=-NOVITA_API_KEY=-BROWSER_USE_LOGGING_LEVEL=debug # Helpful for development+# set logging level+echo "BROWSER_USE_LOGGING_LEVEL=debug" >> .env```-<Note>- See [Supported Models](/customize/supported-models) for available LLM options- and their specific API key requirements.-</Note>--## 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+## Helper Scripts+For common development tasks```bash-# Run the linter on the whole project (must pass for PR to be allowed to merge)-uv run pre-commit run --all-files-# or use our convenience script-./bin/lint.sh+# Complete setup script - installs uv, creates a venv, and installs dependencies+./bin/setup.sh-# Install the linter & formatter pre-commit hooks to run automatically-pre-commit install --install-hooks+# Run all pre-commit hooks (formatting, linting, type checking)+./bin/lint.sh-# Experimental: run the type checker-uv run type+# Run the core test suite that's executed in CI+./bin/test.sh```-### Tests-```bash-# Run all tests that run in CI-./bin/test.sh-# Run specific tests-uv run pytest # run everything-uv run pytest tests/test_tools.py # run a specific test file-uv run pytest tests/test_sensitive_data.py tests/test_tab_management.py # run two test files-uv run pytest tests/test_tab_management.py::TestTabManagement::test_user_changes_tab # run a single test-```--### Build+## Run examples```bash-uv build-uv pip install dist/*.whl--# push build to PyPI (automatically run by Github Actions CI)-uv publish+uv run examples/simple.py```-## Getting Help-If you run into any issues:++## Get help+More than 20k developers help each other.1. Check our [GitHub Issues](https://github.com/browser-use/browser-use/issues)-2. Join our [Discord community](https://link.browser-use.com/discord) for support+2. Join our [Discord community](https://link.browser-use.com/discord)-<Note>- We welcome contributions! See our [Contribution- Guide](/development/contribution-guide) for guidelines on how to help improve- Browser Use.-</Note>diff --git a/docs/quickstart_llm.mdx b/docs/quickstart_llm.mdxindex 5448aced2..53dc2d137 100644--- a/docs/quickstart_llm.mdx+++ b/docs/quickstart_llm.mdx@@ -6,5 +6,5 @@ icon: "brain"-1. Copy all content [🔗 from here](https://docs.browser-use.com/llms-full.txt) (~40k tokens)+1. Copy all content [🔗 from here](https://docs.browser-use.com/llms-full.txt) (~32k tokens)2. Paste it into your favorite coding agent (Cursor, Claude, ChatGPT ...).