Repository files navigation

Browserable allows you to build browser agents that can navigate sites, fill out forms, clicking buttons and extract information. It is currently at 90.4% on the Web Voyager benchmarks.

The fastest way to get started is to run the npx command. This will guide you through the setup process and ensure you have all required dependencies.

npx browserable

Visithttp://localhost:2001 to set your LLM and Remote Browser API Keys to start using.

Clone the repository:

git clone https://github.com/browserable/browserable.gitcd browserable

Pre-requisites:

• InstallDocker
• InstallDocker Compose

Start the development environment:

cd deploymentdocker-compose -f docker-compose.dev.yml up

Set your API keys:

• Open Browserable admin dashboard:http://localhost:2001/dash/@admin/settings.
• Set API key of any one LLM provider (Gemini/ Open AI/ Claude).
• Sign up for a free plan with any one remote browser provider (Hyperbrowser/Steel).
• Set the API key of the remote browser provider in yourBrowserable admin dashboard.

Once running, you'll have access to the following services:

Install the SDK using npm:

npm install browserable-js

Or using yarn:

yarn add browserable-js

Here’s a simple example to get you started:

import{Browserable}from'browserable-js';// Initialize the SDKconstbrowserable=newBrowserable({apiKey:'your-api-key'});// Create and run a taskasyncfunctionrunTask(){constcreateResult=awaitbrowserable.createTask({task:'Find the top trending GitHub repos of the day.',agent:'BROWSER_AGENT'});// Wait for task completionconstresult=awaitbrowserable.waitForRun(taskId);console.log('Results:',result.data);}

Task: On amazon.com search for a yoga mat at least 6mm thick, non-slip, eco-friendly, and under $50.

Task: On arxiv.org locate the latest paper within the 'Nonlinear Sciences - Chaotic Dynamics' category, summarize the abstract, and note the submission date.

Task: On coursera.com find a beginner-level online course about '3d printing' which lasts 1-3 months, and is provided by a renowned university.

Browserable offers configuration options for:

• LLM Providers
• Storage Solutions
• Database Systems
• Remote Browsers
• Custom Functions

For a complete list of environment variables and their configurations, seeEnvironment Variables Documentation.

Seebrowserable.ai/docs for full documentation, or you can check theREST API reference/JS SDK guide.

Browserable is an open-source and self-hostable project. We welcome contributions! 💛

Here's how you can help:

1. Fork the repository.
2. Create your feature branch (git checkout -b feature/AmazingFeature).
3. Commit your changes (git commit -m 'Added AmazingFeature').
4. Push to the branch (git push origin feature/AmazingFeature).
5. Open a pull request.

Questions/ feedback?Join Discord.

Some amazing open source projects Browserable wouldn't have been possible without:bull,mongo-express,Stagehand,Supabase.