web-ui README

The project's README from github.com/browser-use/web-ui. As one markdown file: README.md.

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.

Your browser does not support playing this video!

Installation Guide

Option 1: 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

Step 2: Set Up Python Environment

We recommend using uv for managing the Python environment.

Using uv (recommended):

uv venv --python 3.11

Activate the virtual environment:

.venv\Scripts\activate

.\.venv\Scripts\Activate.ps1

source .venv/bin/activate

Step 3: Install Dependencies

Install Python packages:

uv pip install -r requirements.txt

Install Browsers in playwright. 

playwright install --with-deps

Or you can install specific browsers by running:

playwright install chromium --with-deps

Step 4: Configure Environment

  1. Create a copy of the example environment file:
copy .env.example .env

cp .env.example .env
  1. Open .env in your preferred text editor and add your API keys and other settings

Step 5: Enjoy the web-ui

  1. Run the WebUI:
    python webui.py --ip 127.0.0.1 --port 7788
  2. Access the WebUI: Open your web browser and navigate to http://127.0.0.1:7788.
  3. Using Your Own Browser(Optional):
    • Set BROWSER_PATH to the executable path of your browser and BROWSER_USER_DATA to the user data directory of your browser. Leave BROWSER_USER_DATA empty if you want to use local user data.
      • Windows
         BROWSER_PATH="C:\Program Files\Google\Chrome\Application\chrome.exe"
 BROWSER_USER_DATA="C:\Users\YourUsername\AppData\Local\Google\Chrome\User Data"

        Note: Replace YourUsername with your actual Windows username for Windows systems.

      • Mac
         BROWSER_PATH="/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"
 BROWSER_USER_DATA="/Users/YourUsername/Library/Application Support/Google/Chrome"
    • Close all Chrome windows
    • Open the WebUI in a non-Chrome browser, such as Firefox or Edge. This is important because the persistent browser context will use the Chrome data when running the agent.
    • Check the "Use Own Browser" option within the Browser Settings.

Option 2: Docker Installation

Prerequisites

Step 1: Clone the Repository

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

Step 2: Configure Environment

  1. Create a copy of the example environment file:
copy .env.example .env

cp .env.example .env
  1. Open .env in your preferred text editor and add your API keys and other settings

Step 3: Docker Build and Run

docker compose up --build

For ARM64 systems (e.g., Apple Silicon Macs), please run follow command:

TARGETPLATFORM=linux/arm64 docker compose up --build

Step 4: Enjoy the web-ui and vnc

Changelog

web-ui (browser-use/web-ui)

Searching Database…

16.6K ·GitHub
Web-ui
What is this?A Gradio web UI for the browser-use library: give a task to an AI agent and watch it drive a real browser. It supports many LLMs — OpenAI, Anthropic, Google, Azure OpenAI, DeepSeek, Ollama and more.
So it's an app on top of browser-use, not the library itself?Right — the browser-use library makes websites accessible to AI agents, and this project wraps it in a browser-based interface. The library does the automation; web-ui is its control panel.
How do I get it running?Clone the repo, set up a Python environment (uv is recommended), install the packages plus Playwright browsers, copy .env.example to .env and add your API keys, then run the WebUI and open it in your browser.
Which AI models can power the agent — do I have to pay for API access?You put API keys in .env for OpenAI, Anthropic, Google, Azure OpenAI or DeepSeek — or point it at Ollama and run models locally for free. More providers are planned.
Does it run on my machine or in the cloud?On your own machine: install steps cover Windows, macOS and Linux, with a dedicated Docker command for ARM64 systems like Apple Silicon Macs.
Can I make the agent use my regular Chrome with all my logins?Yes: set BROWSERPATH and BROWSERUSERDATA in .env and tick 'Use Own Browser' in settings to keep your logins. On Windows, close all Chrome windows and open the WebUI in a non-Chrome browser.
Does the browser stay open between tasks?Yes — persistent browser sessions let you keep the browser window open between AI tasks, so you can review the complete history and state of the agent's interactions.
How can I watch what the agent is doing?With the Docker setup a VNC viewer comes built in, so you can watch the agent's browser live; the default password is 'youvncpassword', changeable via VNCPASSWORD in .env.
Can it record what the agent does?Yes — the custom browser feature supports high-definition screen recording of the agent's session.
What are similar projects?browser-harness, MoneyPrinterTurbo, aichat, self-operating-computer, unsloth, solari-cookbook, pyvideotrans, NextChat
Which topics is it in?cloud-browser, screen-recording, vnc, gradio, webui, playwright, browser-automation, local-llm, ollama, deepseek, anthropic, ai-agent
Creator
browser-use
Size
18.9 MB
Stars
16.6K
Updated
CommitMay 15Releasev3.0.0Aug 31
Age
1y
Commits · 90 Days