| |
| title: "Local Setup" |
| description: "Set up Browser Use development environment locally" |
| icon: "laptop-code" |
| |
|
|
| |
|
|
| Browser Use requires Python 3.11 or higher. We recommend using [uv](https://docs.astral.sh/uv/) for Python environment management. |
|
|
| |
|
|
| First, clone the Browser Use repository: |
|
|
| ```bash |
| git clone https://github.com/browser-use/browser-use |
| cd browser-use |
| ``` |
|
|
| |
|
|
| 1. Create a virtual environment: |
|
|
| ```bash |
| uv venv |
| ``` |
|
|
| 2. Install dependencies: |
|
|
| ```bash |
| |
| uv pip install -e ".[dev]" |
| ``` |
|
|
| <Note> |
| The `-e` flag installs the package in "editable" mode, which means your local code changes |
| will be reflected immediately without requiring reinstallation. The `[dev]` part installs |
| additional dependencies needed for development. |
| </Note> |
|
|
| |
|
|
| Set up your environment variables: |
|
|
| ```bash |
| |
| cp .env.example .env |
| ``` |
|
|
| Or manually create a `.env` file with your API keys: |
|
|
| ```bash .env |
| OPENAI_API_KEY= |
| ANTHROPIC_API_KEY= |
| ``` |
|
|
| <Note> |
| You can use any LLM model supported by LangChain. See [LangChain |
| Models](/customize/supported-models) for available options and their specific |
| API key requirements. |
| </Note> |
|
|
| |
|
|
| After setup, you can: |
|
|
| - Run tests with `pytest` |
| - Build the package with `hatch build` |
| - Try the examples in the `examples/` directory |
|
|
| |
|
|
| If you run into any issues: |
|
|
| 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 |
|
|
| <Note> |
| We welcome contributions! See our [Contribution |
| Guide](/development/contribution-guide) for guidelines on how to help improve |
| Browser Use. |
| </Note> |
|
|