diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..d154fd3 --- /dev/null +++ b/README.en.md @@ -0,0 +1,304 @@ + + + + Shows a black Browser Use Logo in light color mode and a white one in dark color mode. + + +
+ + + + The AI browser agent. + +
+ +
+Browser-Use Package Download Statistics +
+ +--- + +
+Demos + +Docs + +Blog + +Merch + +Github Stars + +Twitter + +Discord + +Browser-Use Cloud +
+ +
+ +# What can Browser Use do? + +Browser Use lets an AI agent use a web browser the same way you do β€” it opens pages, clicks buttons, types, and fills in forms. You describe the task, and it completes it. For example, you can have it: + + +### πŸ“‹ Fill Forms +#### Task: "Fill in this job application with my resume and information." +![Job Application Demo](https://github.com/user-attachments/assets/57865ee6-6004-49d5-b2c2-6dff39ec2ba9) +[Example code β†—](https://github.com/browser-use/browser-use/blob/main/examples/use-cases/apply_to_job.py) + + +### 🍎 Shop for Groceries +#### Task: "Put this list of items into my instacart." + +https://github.com/user-attachments/assets/a6813fa7-4a7c-40a6-b4aa-382bf88b1850 + +[Example code β†—](https://github.com/browser-use/browser-use/blob/main/examples/use-cases/buy_groceries.py) + + +### πŸ’» Be Your Personal Assistant +#### Task: "Help me find parts for a custom PC." + +https://github.com/user-attachments/assets/ac34f75c-057a-43ef-ad06-5b2c9d42bf06 + +[Example code β†—](https://github.com/browser-use/browser-use/blob/main/examples/use-cases/pcpartpicker.py) + + +
+ +# Quickstart + +If you want to use Browser Use in your agent (Claude Code, Codex, Cursor, Hermes, OpenClaw, etc.), paste this prompt, and it sets everything up itself: + +```text +Install or upgrade browser-use to the latest stable version with uv using Python 3.12, run `browser-use skill install` to register the skill, and connect it to my browser. If setup or connection fails, follow https://github.com/browser-use/browser-harness/blob/main/install.md. +``` + +Then tell your agent what you want done. + +
+ +# Python library: the easiest way to automate the web + +Want to automate the web at scale, from your own code, and with any LLM? Use the Python library: + +**1. Install Browser Use (Python >= 3.11):** + +```bash +uv add browser-use +# or: pip install browser-use +``` + +**2. Add your LLM API key to `.env`**. Get one from [Browser Use Cloud](https://cloud.browser-use.com/new-api-key?utm_source=github&utm_medium=readme-quickstart-api-key), or bring your own provider key: + +```bash +# .env +BROWSER_USE_API_KEY=your-key +# GOOGLE_API_KEY=your-key +# ANTHROPIC_API_KEY=your-key +``` + +**3. Run your first agent:** + +```python +import asyncio + +from browser_use import Agent, ChatBrowserUse + +async def main(): + agent = Agent( + task="Find the number of stars of the browser-use repo", + llm=ChatBrowserUse(model='openai/gpt-5.5'), + # llm=ChatBrowserUse(model='bu-2-0'), # Browser Use's optimized model + # llm=ChatOpenAI(model='gpt-5.5'), + # llm=ChatAnthropic(model='claude-opus-4-8'), # Sonnet also works well + ) + history = await agent.run() + +if __name__ == "__main__": + asyncio.run(main()) +``` + +Check out the [library docs](https://docs.browser-use.com/open-source/introduction) and the [cloud docs](https://docs.cloud.browser-use.com?utm_source=github&utm_medium=readme-cloud-docs) for more! + +
+ +# Open Source vs Cloud + + + + + BU Bench V1 - LLM Success Rates + + +We benchmark Browser Use across 100 real-world browser tasks. Full benchmark is open source: **[browser-use/benchmark](https://github.com/browser-use/benchmark)**. + +Browser Use is also **#1 on the [Odysseys leaderboard](https://odysseysbench.com/leaderboard)** with an 87.4% average, ahead of computer-use agents from OpenAI, Anthropic, Google, and Microsoft. Odysseys measures the agent's performance on 200 long-horizon web tasks. + +**Use the Open-Source Agent** +- Free, and runs on your own machine +- Deep code-level integration and control: pick your LLM, customize the agent's behavior +- We recommend pairing it with our [cloud browsers](https://docs.browser-use.com/open-source/customize/browser/remote) for leading stealth, proxy rotation, and scaling + +**Use the [Fully-Hosted Cloud Agent](https://cloud.browser-use.com?utm_source=github&utm_medium=readme-hosted-agent) (recommended)** +- Much more powerful agent for complex tasks (see plot above) +- Easiest way to start and scale +- Best stealth with proxy rotation and captcha solving +- 1000+ integrations (Gmail, Slack, Notion, and more) +- Persistent filesystem and memory + +
+ +## Integrations, hosting, custom tools, MCP, and more on our [Docs β†—](https://docs.browser-use.com) + +
+ +# FAQ + +
+Should I use the CLI vs. the Python library? + +**Use the CLI** if you already have an agent (Claude Code, Codex, Cursor, Hermes, OpenClaw, etc.) that you want to complete browser tasks for you. The agent installs the skill once (see [Quickstart](#quickstart)) and can then control the browser. Examples: +- "Upload this video to YouTube" +- "Compare these three laptops and give me a table with prices" +- "Fill in this job application with my resume" + +**Use the Python library** when you are building software that automates the web. Examples: +- Run many tasks on a schedule or in parallel (scraping, monitoring, QA) +- Embed a browser agent into your own product +- Custom tools, custom system prompts, structured output, fine-grained browser control + +Rule of thumb: one-off tasks through an agent β†’ CLI. Repeatable automation in code β†’ Python library. +
+ +
+What's the best model to use? + +We optimized **ChatBrowserUse()** specifically for browser automation tasks. On avg it completes tasks 3-5x faster than other models with SOTA accuracy. + +For pricing and other LLM providers, see our [supported models documentation](https://docs.browser-use.com/supported-models). +
+ +
+Can I use Claude / GPT / Gemini through ChatBrowserUse? + +Yes. `ChatBrowserUse` accepts provider-prefixed model ids, so a single `BROWSER_USE_API_KEY` reaches all of them β€” no separate OpenAI/Anthropic/Google keys required: + +```python +from browser_use import Agent, ChatBrowserUse + +llm = ChatBrowserUse(model='anthropic/claude-sonnet-4-6') # or 'openai/gpt-5.5', 'google/gemini-3-pro' +agent = Agent(task='...', llm=llm) +``` + +For the best speed and cost we still recommend the default `bu-*` models. +
+ +
+Should I use the Browser Use system prompt with the open-source preview model? + +Yes. If you use `ChatBrowserUse(model='browser-use/bu-30b-a3b-preview')` with a normal `Agent(...)`, Browser Use still sends its default agent system prompt for you. + +You do **not** need to add a separate custom "Browser Use system message" just because you switched to the open-source preview model. Only use `extend_system_message` or `override_system_message` when you intentionally want to customize the default behavior for your task. + +If you want the best default speed/accuracy, we still recommend the newer hosted `bu-*` models. If you want the open-source preview model, the setup stays the same apart from the `model=` value. +
+ +
+Can I use custom tools with the agent? + +Yes! You can add custom tools to extend the agent's capabilities: + +```python +from browser_use import Tools + +tools = Tools() + +@tools.action(description='Description of what this tool does.') +def custom_tool(param: str) -> str: + return f"Result: {param}" + +agent = Agent( + task="Your task", + llm=llm, + browser=browser, + tools=tools, +) +``` + +
+ +
+Can I use this for free? + +Yes! Browser-Use is open source and free to use. You only need to choose an LLM provider (like OpenAI, Google, ChatBrowserUse, or run local models with Ollama). +
+ +
+Terms of Service + +This open-source library is licensed under the MIT License. For Browser Use services & data policy, see our [Terms of Service](https://browser-use.com/legal/terms-of-service) and [Privacy Policy](https://browser-use.com/privacy/). +
+ +
+How do I handle authentication? + +Check out our authentication examples: +- [Using real browser profiles](https://github.com/browser-use/browser-use/blob/main/examples/browser/real_browser.py) - Reuse your existing Chrome profile with saved logins +- If you want to use temporary accounts with inbox, choose AgentMail +- To sync your auth profile with the remote browser, run `curl -fsSL https://browser-use.com/profile.sh | BROWSER_USE_API_KEY=XXXX sh` (replace XXXX with your API key) + +These examples show how to maintain sessions and handle authentication seamlessly. +
+ +
+How do I solve CAPTCHAs? + +For CAPTCHA handling, you need better browser fingerprinting and proxies. Use [Browser Use Cloud](https://cloud.browser-use.com?utm_source=github&utm_medium=readme-faq-captcha) which provides stealth browsers designed to avoid detection and CAPTCHA challenges. +
+ +
+How do I go into production? + +Chrome can consume a lot of memory, and running many agents in parallel can be tricky to manage. + +For production use cases, use our [Browser Use Cloud API](https://cloud.browser-use.com?utm_source=github&utm_medium=readme-faq-production) which handles: +- Scalable browser infrastructure +- Memory management +- Proxy rotation +- Stealth browser fingerprinting +- High-performance parallel execution +
+ +
+ +## Citation + +If you use Browser Use in your research or project, please cite: + +```bibtex +@software{browser_use2024, + author = {Müller, Magnus and Žunič, Gregor}, + title = {Browser Use: Enable AI to control your browser}, + year = {2024}, + publisher = {GitHub}, + url = {https://github.com/browser-use/browser-use} +} +``` + +
+ +
+ +**Tell your computer what to do, and it gets it done.** + + + +[![Twitter Follow](https://img.shields.io/twitter/follow/Magnus?style=social)](https://x.com/intent/user?screen_name=mamagnus00) +    +[![Twitter Follow](https://img.shields.io/twitter/follow/Gregor?style=social)](https://x.com/intent/user?screen_name=gregpr07) + +
+ +
Made with ❀️ in Zurich and San Francisco