Skip to main content
To get started with OpenBrowser you need to install the package and create an .env file with your API key.

​
1. Installing OpenBrowser

create environment
pip install uv
uv venv --python 3.12
activate environment
source .venv/bin/activate
# On Windows use `.venv\Scripts\activate`
install openbrowser & chromium
uv pip install openbrowser-ai
uvx openbrowser install

​
2. Choose your favorite LLM

Create a .env file and add your API key.
.env
touch .env
On Windows, use echo. > .env
Then add your API key to the file. 
# add your key to .env file
GOOGLE_API_KEY=
# Get your free Gemini API key from https://aistudio.google.com/app/u/1/apikey
See Supported Models for more.

​
3. Run your first agent

from openbrowser import Agent, ChatBrowserUse
from dotenv import load_dotenv
import asyncio

load_dotenv()

async def main():
    llm = ChatBrowserUse()
    task = "Find the number 1 post on Show HN"
    agent = Agent(task=task, llm=llm)
    await agent.run()

if __name__ == "__main__":
    asyncio.run(main())
Custom browsers can be configured in one line. Check out browsers for more.

​
4. Going to Production

For production deployments, see Going to Production for best practices on running OpenBrowser in production environments.