安装

文档索引

可在此获取完整文档索引：https://docs.stagehand.dev/llms.txt

在进一步浏览前，可使用该文件发现所有可用页面。

在当前应用中通过 TypeScript SDK 安装 Stagehand。

提示

我们建议使用 Node.js 运行时来执行 Stagehand 脚本。

现已支持 Bun，前提是你不要将 Stagehand 与 Playwright 集成。Playwright 与 Bun 不兼容。

TypeScript

安装依赖

npm

npm install @browserbasehq/stagehand

pnpm

pnpm add @browserbasehq/stagehand

yarn

yarn add @browserbasehq/stagehand

bun

bun add @browserbasehq/stagehand

提示

如果你打算在本地运行，则需要在你的机器上安装 Chrome。如果你使用云浏览器会话，则可跳过这一步。

配置环境

设置环境变量（或者通过你的框架使用 .env）：

OPENAI_API_KEY=your_api_key
BROWSERBASE_API_KEY=your_api_key

说明

Stagehand 不会自动加载 .env 文件。

如果你使用 .env 文件，请在你自己的应用代码中安装并初始化 dotenv：

npm install dotenv

import dotenv from "dotenv";
dotenv.config({ path: ".env" });

在你的代码库中使用

在需要浏览器自动化的地方引入 Stagehand。

import dotenv from "dotenv";
import { Stagehand } from "@browserbasehq/stagehand";
import { z } from "zod";

dotenv.config({ path: ".env" });  // 如有需要

async function main() {
  const stagehand = new Stagehand({
    env: "BROWSERBASE"
  });

  await stagehand.init();
  const page = stagehand.context.pages()[0];

  await page.goto("https://example.com");

  // 在页面上执行操作
  await stagehand.act("Click the learn more button");

  // 提取结构化数据
  const description = await stagehand.extract("extract the description", z.string());

  console.log(description);
  await stagehand.close();
}

main().catch((err) => {
  console.error(err);
  process.exit(1);
});

Other Languages

说明

对于 Python 以及其他语言的 SDK，请使用侧边栏左上角的语言选择器，查看对应语言的 SDK 文档。

下一步

Configuration

环境、Browserbase 与 Local 的差异、日志、超时以及 LLM 自定义。

查看原文

Act

使用自然语言执行精确操作。

查看原文

Extract

使用 Zod schema 提取强类型数据。

查看原文

Observe

发现页面元素与建议操作。

查看原文