Skip to content

README.md

Latest commit

 

History

History
109 lines (83 loc) · 4.69 KB

README.md

File metadata and controls

109 lines (83 loc) · 4.69 KB

Browser Use Web UI


GitHub stars Discord Documentation WarmShao

This project builds upon the foundation of the browser-use, which is designed to make websites accessible for AI agents.

We would like to officially thank WarmShao for his contribution to this project.

WebUI: is built on Gradio and supports most of browser-use functionalities. This UI is designed to be user-friendly and enables easy interaction with the browser agent.

Expanded LLM Support: We've integrated support for various Large Language Models (LLMs), including: Google, OpenAI, Azure OpenAI, Anthropic, DeepSeek, Ollama etc. And we plan to add support for even more models in the future.

Custom Browser Support: You can use your own browser with our tool, eliminating the need to re-login to sites or deal with other authentication challenges. This feature also supports high-definition screen recording.

Persistent Browser Sessions: You can choose to keep the browser window open between AI tasks, allowing you to see the complete history and state of AI interactions.

bu-webui-demo.mp4

Source Code (.zip)

Installation Guide

Prerequisites

  • Python 3.11 or higher
  • Git (for cloning the repository)

Local Installation

Read the quickstart guide or follow the steps below to get started.

Step 1: Clone the Repository

git clone https://github.com/browser-use/web-ui.git
cd web-ui-release/web-ui-1.6

Step 2: Set Up Python Environment

We recommend using virtual environment to manage Python dependencies.

python -m venv .venv

Activate the virtual environment:

  • Windows (Command Prompt):
.venv\Scripts\activate
  • Windows (PowerShell):
.\.venv\Scripts\Activate.ps1
  • macOS/Linux:
source .venv/bin/activate

Step 3: Install Dependencies

Install Python packages from the requirements.txt file:

pip install -r requirements.txt

Install Playwright:

playwright install

Step 4: Configure Environment

  1. Create a copy of the example environment file:
cp .env.example .env
  1. Open .env in your preferred text editor and add your API keys and other settings

Usage

Local Setup

  1. Run the WebUI: After completing the installation steps above, start the application from the web-ui-release/web-ui-1.6 directory: 
    python webui.py --ip 127.0.0.1 --port 7788
  2. WebUI options:
    • --ip: The IP address to bind the WebUI to. Default is 127.0.0.1.
    • --port: The port to bind the WebUI to. Default is 7788.
    • --theme: The theme for the user interface. Default is Ocean.
      • Default: The standard theme with a balanced design.
      • Soft: A gentle, muted color scheme for a relaxed viewing experience.
      • Monochrome: A grayscale theme with minimal color for simplicity and focus.
      • Glass: A sleek, semi-transparent design for a modern appearance.
      • Origin: A classic, retro-inspired theme for a nostalgic feel.
      • Citrus: A vibrant, citrus-inspired palette with bright and fresh colors.
      • Ocean (default): A blue, ocean-inspired theme providing a calming effect.
    • --dark-mode: Enables dark mode for the user interface.
  3. Access the WebUI: Open your web browser and navigate to http://127.0.0.1:7788.

Changelog

  • 2025/01/26: Thanks to @vvincent1234. Now browser-use-webui can combine with DeepSeek-r1 to engage in deep thinking!
  • 2025/01/10: Thanks to @casistack. Now we have Docker Setup option and also Support keep browser open between tasks.Video tutorial demo.
  • 2025/01/06: Thanks to @richard-devbot. A New and Well-Designed WebUI is released. Video tutorial demo.

MIT LICENSE