Browserable 允许你构建能够导航网站、填写表单、点击按钮并提取信息的浏览器代理。目前在 Web Voyager 基准测试中得分达到 90.4%。

快速入门

最快开始的方式是运行 npx 命令。这将引导你完成设置过程，并确保你拥有所有必要的依赖项。

npx browserable

访问 http://localhost:2001，设置你的 LLM 和远程浏览器 API 密钥即可开始使用。

手动设置

克隆仓库：

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

先决条件：

• 安装 Docker
• 安装 Docker Compose

启动开发环境：

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

设置 API 密钥：

• 打开 Browserable 管理仪表板：http://localhost:2001/dash/@admin/settings。
• 设置任意一个 LLM 提供商（Gemini/ OpenAI/ Claude）的 API 密钥。
• 在任意一家远程浏览器提供商处注册免费计划（Hyperbrowser/ Steel）。
• 将远程浏览器提供商的 API 密钥设置到你的 Browserable 管理仪表板 中。

服务

运行后，你将可以访问以下服务：

服务	URL/端口	描述
UI 服务器	http://localhost:2001	主用户界面
文档	http://localhost:2002	本地文档
任务服务器	http://localhost:2003	任务管理 API
MongoDB	27017	数据库
MongoDB Express UI	http://localhost:3300	数据库管理
Redis	6379	缓存和队列
MinIO API	http://localhost:9000	对象存储 API
MinIO 控制台	http://localhost:9001	对象存储 UI
DB Studio	http://localhost:8000	数据库管理

JavaScript SDK

使用 npm 安装 SDK：

npm install browserable-js

或者使用 yarn：

yarn add browserable-js

以下是一个简单的示例，帮助你快速上手：

import { Browserable } from 'browserable-js';

// 初始化 SDK
const browserable = new Browserable({
  apiKey: 'your-api-key'
});

// 创建并运行任务
async function runTask() {
  const createResult = await browserable.createTask({
    task: '查找当天最热门的 GitHub 仓库。',
    agent: 'BROWSER_AGENT'
  });

  // 等待任务完成
  const result = await browserable.waitForRun(taskId);
  console.log('结果:', result.data);
}

演示

任务：在 amazon.com 上搜索至少 6 毫米厚、防滑、环保且价格低于 50 美元的瑜伽垫。

任务：在 arxiv.org 上找到“非线性科学—混沌动力学”类别下的最新论文，总结其摘要并记录提交日期。

任务：在 coursera.com 上找到一门由知名大学提供的、时长 1–3 个月的“3D 打印”初级在线课程。

配置选项

Browserable 提供以下配置选项：

• LLM 提供商
• 存储解决方案
• 数据库系统
• 远程浏览器
• 自定义函数

有关环境变量及其配置的完整列表，请参阅 环境变量文档。

文档

完整的文档请参见 browserable.ai/docs，你也可以查看 REST API 参考 或 JS SDK 指南。

贡献

Browserable 是一个开源且可自托管的项目。我们欢迎任何贡献！💛

你可以通过以下方式参与：

1. 分支仓库。
2. 创建你的功能分支 (git checkout -b feature/AmazingFeature)。
3. 提交更改 (git commit -m '添加了 AmazingFeature')。
4. 推送到分支 (git push origin feature/AmazingFeature)。
5. 打开拉取请求。

支持

有问题或反馈？加入 Discord。

致谢

Browserable 的成功离不开一些优秀的开源项目：bull、mongo-express、Stagehand、Supabase。

Browserable 快速上手指南

Browserable 是一个开源的浏览器自动化库，专为 AI Agent 设计。它支持导航网站、填写表单、点击按钮及提取信息，在 Web Voyager 基准测试中得分高达 90.4%。

环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统：支持 Docker 的主流操作系统 (Linux, macOS, Windows)
• 前置依赖：
  • Docker
  • Docker Compose
• API Keys：
  • 大语言模型提供商密钥（支持 Gemini, OpenAI, Claude 等）
  • 远程浏览器提供商密钥（支持 Hyperbrowser, Steel 等，需注册免费计划）

安装步骤

您可以选择通过 npx 快速启动，或通过源码手动部署开发环境。

方式一：快速启动 (推荐)

使用 npx 命令可自动引导设置过程并确保安装所有必要依赖：

npx browserable

运行后，访问 http://localhost:2001 配置您的 LLM 和远程浏览器 API Key 即可开始使用。

方式二：手动部署 (开发模式)

如果您需要自定义开发或查看源码，请按以下步骤操作：

1. 克隆仓库：

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

2. 启动开发环境：

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

3. 配置 API Keys：

   • 打开管理后台：http://localhost:2001/dash/@admin/settings
   • 填入任意一个 LLM 提供商的 API Key。
   • 填入已注册的远程浏览器提供商的 API Key。

基本使用

安装完成后，您将拥有多个服务端口（如 UI 界面 2001，文档 2002，任务 API 2003 等）。最核心的功能是通过 JavaScript SDK 调用浏览器代理执行任务。

1. 安装 SDK

使用 npm 或 yarn 安装官方 SDK：

npm install browserable-js

或者

yarn add browserable-js

2. 代码示例

以下是一个简单的 TypeScript 示例，演示如何创建并运行一个搜索任务：

import { Browserable } from 'browserable-js';

// 初始化 SDK
const browserable = new Browserable({
  apiKey: 'your-api-key'
});

// 创建并运行任务
async function runTask() {
  const createResult = await browserable.createTask({
    task: 'Find the top trending GitHub repos of the day.',
    agent: 'BROWSER_AGENT'
  });

  // 等待任务完成
  // 注意：实际使用时请使用 createResult 返回的 taskId
  const taskId = createResult.id; 
  const result = await browserable.waitForRun(taskId);
  
  console.log('Results:', result.data);
}

典型应用场景

Browserable 能够处理复杂的网页交互任务，例如：

• 电商搜索：在 Amazon 查找特定规格（厚度、防滑、环保、价格限制）的商品。
• 学术检索：在 arXiv 定位最新论文，总结摘要并记录提交日期。
• 课程筛选：在 Coursera 寻找由知名大学提供、时长适中且适合初学者的特定主题课程。

更多详细配置选项（如存储方案、数据库系统、自定义函数等），请参阅 官方文档。