Steel

面向AI智能体与应用的开源浏览器API。 构建实时网络智能体和浏览器自动化工具的最佳方式。

开始使用 · 文档 · 官网 · 食谱

✨ 亮点

Steel.dev 是一个开源浏览器API，让构建与网页交互的AI应用和智能体变得简单。无需从头开始搭建自动化基础设施，你可以专注于自己的AI应用，而复杂的细节则由Steel来处理。

在底层，它管理会话、页面和浏览器进程，使你能够以编程方式执行复杂的浏览任务，而无需面对各种麻烦：

• 完全浏览器控制：使用Puppeteer和CDP对Chrome实例进行全面控制——支持通过Puppeteer、Playwright或Selenium连接。
• 会话管理：跨请求维护浏览器状态、Cookie和本地存储。
• 代理支持：内置代理链管理，便于IP轮换。
• 扩展支持：可加载自定义Chrome扩展，增强功能。
• 调试工具：内置请求日志记录，并提供UI用于查看和调试会话。
• 反检测：包含隐身插件和指纹管理功能。
• 资源管理：自动清理和浏览器生命周期管理。
• 浏览器工具：提供API，可快速将页面转换为Markdown、可读性文本、截图或PDF。

有关详细的API文档和示例，请参阅我们的API参考，或直接访问http://0.0.0.0:3000/documentation的Swagger UI。

Steel目前处于公开测试阶段，每天都在不断演进。你的建议、想法和报告的Bug对我们帮助极大。请随时加入Discord的讨论，或在GitHub上提交问题。我们会阅读每一条反馈，回复大多数问题，非常感谢！

如果你热爱开源、AI和开发工具，我们正在全栈招聘！点击了解详情！

别忘了给我们点个星⭐

🛠️ 入门指南

开始使用Steel最简单的方式是创建一个Steel Cloud账户。当然，你也可以将Steel浏览器实例部署到云服务商，或者在本地运行。

⚡ 快速部署

如果你想部署到云服务商，我们已经为你准备好了方案。

部署方式	链接
预构建Docker镜像（API+UI合一）
一键部署至Railway
一键部署至Render

💻 本地运行

Docker

在本地部署或运行Steel浏览器实例的最简单方法是使用预构建的Docker镜像：

# 拉取并运行Docker镜像
docker run -p 3000:3000 -p 9223:9223 ghcr.io/steel-dev/steel-browser

这将在端口3000启动Steel浏览器服务器（http://localhost:3000），并在http://localhost:3000/ui启动UI界面。端口9223用于控制台调试器。

现在你可以创建会话、抓取页面、截屏等操作。跳转到使用说明部分，获取一些快速示例，了解如何操作。

此外，你也可以使用Docker Compose分别运行API和UI：

docker compose up

对于使用M1/M2芯片的Mac用户，需要在Docker Compose命令中添加以下环境变量，以确保镜像在正确的平台上运行：

DOCKER_DEFAULT_PLATFORM=linux/arm64 docker compose up

贡献者快速入门

在本地开发时，你需要运行docker-compose.dev.yml文件，而不是默认的docker-compose.yml，这样才能反映你的本地更改。这样做会从[api](./api)和[ui](./ui)目录构建Docker镜像，并分别在端口3000和5173运行服务器和UI。

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

同时，每次修改代码后都需要加上--build参数，以确保Docker镜像被重新构建：

docker compose -f docker-compose.dev.yml up --build

如果你使用自定义主机，可以创建一个.env文件（详见docs/DEVELOPMENT_SETUP.md中的变量说明），或者修改docker-compose.dev.yml中使用的环境变量，以适配你的主机。

Node.js

或者，如果你已经安装了 Node.js 和 Chrome 浏览器，可以直接运行服务器和 UI：

npm install
npm run dev

这将会在端口 3000 上启动 Steel 服务器，在端口 5173 上启动 UI。

请确保你已安装 Chrome 可执行文件，并且它位于以下路径之一：

• Linux: /usr/bin/google-chrome

• MacOS: /Applications/Google Chrome.app/Contents/MacOS/Google Chrome

• Windows:

  • C:\Program Files\Google\Chrome\Application\chrome.exe 或
  • C:\Program Files (x86)\Google\Chrome\Application\chrome.exe

自定义 Chrome 可执行文件

如果你使用的是自定义的 Chrome 可执行文件或不同的路径，可以将 CHROME_EXECUTABLE_PATH 环境变量设置为你 Chrome 可执行文件的路径：

export CHROME_EXECUTABLE_PATH=/path/to/your/chrome
npm run dev

有关具体检查位置的详细信息，请参阅 api/src/utils/browser.ts。

🏄🏽‍♂️ 使用方法

如果你想快速了解如何使用 Steel，可以查看 Cookbook。

或者，你也可以尝试使用 REPL 包，进入 cd repl 并运行 npm run start。

与 Steel 浏览器 API 进行交互主要有两种方式：

1. 使用会话
2. 使用快速操作 API

在这些示例中，我们假设你的自定义 Steel API 端点是 http://localhost:3000。

完整的 REST OpenAPI 文档可以在我们的网站上找到：https://docs.steel.dev/api-reference，也可以在本地 Steel 实例上访问：http://localhost:3000/documentation。

使用 SDK

如果你更倾向于使用我们的 Python 和 Node.js SDK，可以安装适用于 Node 或 Python 的 steel-sdk 包。

这些 SDK 基于 REST API 构建，提供了更便捷的方式来与 Steel 浏览器 API 交互。它们具有完全的类型支持，并且兼容 Steel Cloud 和自托管的 Steel 实例（可通过 Node 中的 baseURL 选项或 Python 中的 base_url 来更改）。

有关安装和使用 SDK 的更多详细信息，请参阅 Node SDK 参考文档 和 Python SDK 参考文档。

会话

/sessions 端点允许你使用自定义选项或扩展程序重新启动浏览器（例如使用自定义代理），并重置浏览器状态。这对于需要精细控制的复杂、有状态的工作流来说非常理想。

一旦创建了会话，你可以使用会话 ID 或根 URL 与浏览器进行交互。为此，你需要使用 Puppeteer 或 Playwright。你可以在下面的文档中找到一些使用 Puppeteer 和 Playwright 与 Steel 集成的示例：

• Puppeteer 集成
• Playwright 与 Node
• Playwright 与 Python

import Steel from 'steel-sdk';

const client = new Steel({
  baseURL: "http://localhost:3000", // 自定义 API 基础 URL 覆盖
});

(async () => {
  try {
    // 使用当前 API 字段创建一个新的浏览器会话
    const session = await client.sessions.create({
      blockAds: true,
      proxyUrl: "user:pass@host:port", // 可选
      dimensions: { width: 1280, height: 800 }, // 可选
    });
    console.log("创建的会话 ID:", session.id);
  } catch (error) {
    console.error("创建会话时出错:", error);
  }
})();

import os
from steel import Steel

client = Steel(
    base_url="http://localhost:3000",  # 自定义 API 基础 URL 覆盖
)

try:
    # 使用自定义选项创建一个新的浏览器会话
    session = client.sessions.create(
        block_ads=True,
        proxy_url="user:pass@host:port",  # 可选
        dimensions={"width": 1280, "height": 800},  # 可选
    )
    print("创建的会话 ID:", session.id)
except Exception as e:
    print("创建会话时出错:", e)

# 启动一个新的浏览器会话
curl -X POST http://localhost:3000/v1/sessions \
  -H "Content-Type: application/json" \
  -d '{
    "proxyUrl": "user:pass@host:port",
    "blockAds": true,
    "dimensions": { "width": 1280, "height": 800 }
  }'

Selenium 会话

注意: 此集成并不支持基于 CDP 的浏览器会话 API 的所有功能。

对于已有 Selenium 工作流的团队，Steel 浏览器提供了一个即插即用的替代方案，在保持兼容性的同时增加了增强功能。你只需使用 isSelenium 选项即可创建一个 Selenium 会话：

// 使用 Node SDK
const session = await client.sessions.create({ isSelenium: true });

// 使用 Python SDK
session = client.sessions.create(is_selenium=True)

# 启动一个 Selenium 会话
curl -X POST http://localhost:3000/v1/sessions \
  -H "Content-Type: application/json" \
  -d '{
    "isSelenium": true
  }'

Selenium API 完全兼容 Selenium 的 WebDriver 协议，因此你可以使用任何现有的 Selenium 客户端连接到 Steel 浏览器。有关使用 Selenium 与 Steel 的更多信息，请参阅 Selenium 文档。

快速操作 API

/scrape、/screenshot 和 /pdf 端点允许你使用正在运行的 Steel 服务器快速从任何网页中提取干净、格式良好的数据。非常适合简单的只读、按需任务：

# 使用 Actions API 的示例
curl -X POST http://0.0.0.0:3000/v1/scrape \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "delay": 1000
  }'

# 使用 Actions API 的示例
curl -X POST http://0.0.0.0:3000/v1/screenshot \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "fullPage": true
  }' --output screenshot.png

# 使用 Actions API 的示例
curl -X POST http://0.0.0.0:3000/v1/pdf \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com"
  }' --output output.pdf

参与进来

Steel 浏览器是一个开源项目，我们欢迎各方贡献！

• 有问题、想法或反馈？欢迎加入我们的 Discord 社区交流。
• 发现了 bug？请在 GitHub 上提交 issue。

许可证

Apache 2.0

由 Steel 团队用心打造。

Steel Browser 快速上手指南

Steel 是一个开源浏览器 API，专为构建 AI 智能体（Agents）和自动化应用设计。它基于 Puppeteer 和 CDP，提供完整的浏览器控制、会话管理、反检测及代理支持，让你无需从零搭建基础设施即可轻松操作网页。

环境准备

系统要求

• 操作系统: Linux, macOS (包括 Silicon 芯片), Windows
• 运行时: Node.js (推荐 v18+) 或 Docker
• 浏览器: Google Chrome (本地运行模式必需)

前置依赖

若选择本地 Node.js 模式运行，需确保已安装 Chrome 并位于以下默认路径之一：

• Linux: /usr/bin/google-chrome
• macOS: /Applications/Google Chrome.app/Contents/MacOS/Google Chrome
• Windows:
  • C:\Program Files\Google\Chrome\Application\chrome.exe
  • C:\Program Files (x86)\Google\Chrome\Application\chrome.exe

提示: 若 Chrome 安装在自定义路径，需设置环境变量 CHROME_EXECUTABLE_PATH。

安装步骤

推荐使用 Docker 方式部署，最为简便且环境隔离性好。

方法一：使用 Docker（推荐）

拉取并运行预构建的镜像，同时启动 API 服务（端口 3000）和调试 UI：

docker run -p 3000:3000 -p 9223:9223 ghcr.io/steel-dev/steel-browser

注：Mac Silicon (M1/M2/M3) 用户若使用 docker compose，需指定平台：

DOCKER_DEFAULT_PLATFORM=linux/arm64 docker compose up

启动后：

• API 地址：http://localhost:3000
• 管理 UI 地址：http://localhost:3000/ui
• 调试器端口：9223

方法二：本地 Node.js 开发模式

如果你希望直接运行源码或进行二次开发：

# 克隆项目并安装依赖
git clone https://github.com/steel-dev/steel-browser.git
cd steel-browser
npm install

# 启动开发服务器 (API + UI)
npm run dev

若需指定自定义 Chrome 路径：

export CHROME_EXECUTABLE_PATH=/path/to/your/chrome
npm run dev

基本使用

Steel 主要通过 REST API 或官方 SDK (Node.js/Python) 进行交互。以下是两种最常用的场景。

1. 创建浏览器会话 (Sessions)

适用于需要保持状态、执行复杂交互或使用插件的场景。支持通过 Puppeteer 或 Playwright 连接。

使用 Node.js SDK:

import Steel from 'steel-sdk';

const client = new Steel({
  baseURL: "http://localhost:3000", // 本地部署地址
});

(async () => {
  try {
    // 创建新会话，开启广告拦截并设置窗口尺寸
    const session = await client.sessions.create({
      blockAds: true,
      dimensions: { width: 1280, height: 800 },
      // proxyUrl: "user:pass@host:port", // 可选：配置代理
    });
    console.log("会话创建成功，ID:", session.id);
    
    // 获取连接字符串后可用于 Puppeteer/Playwright 连接
    // console.log(session.connectUrl); 
  } catch (error) {
    console.error("创建会话失败:", error);
  }
})();

使用 Python SDK:

from steel import Steel

client = Steel(
    base_url="http://localhost:3000",
)

try:
    session = client.sessions.create(
        block_ads=True,
        dimensions={"width": 1280, "height": 800},
    )
    print("会话创建成功，ID:", session.id)
except Exception as e:
    print("创建会话失败:", e)

2. 快速动作 (Quick Actions)

适用于简单的单次任务，如抓取页面内容、截图或生成 PDF，无需手动管理会话生命周期。

使用 Curl 抓取网页内容:

curl -X POST http://localhost:3000/v1/scrape \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "waitForSelector": null,
    "format": "markdown"
  }'

使用 Curl 截取网页截图:

curl -X POST http://localhost:3000/v1/screenshot \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "fullPage": true
  }' --output screenshot.png

3. 连接 Selenium (可选)

如果你已有 Selenium 工作流，可通过设置 isSelenium: true 创建兼容会话：

// Node.js
const session = await client.sessions.create({ isSelenium: true });

创建后，使用标准的 Selenium WebDriver 连接到返回的 endpoint 即可。