outcrawlai/scout

选用指南

AI 根据 README 整理 · 2026/10/15 14:01:26

适用场景

适用于网页研究、表单填写、商品比较、登录等需要浏览器操作的任务，可返回结构化数据。

查看 README 依据

Tasks you would do in a browser yourself, written the way you would ask a colleague. Each of these is a working example you can run: - **Research.** "Go to Hacker News and report the three stories with the most comments: title, link and comment count." [`research.ts`](packages/scout/examples/research.ts) - **Fill in a form.** "Order a pizza on this form, then tell me exactly what the shop received." [`form-fill.ts`](packages/scout/examples/form-fill.ts)

- **Compare.** "Find these two books and compare their price and stock, then tell me which is cheaper." [`compare.ts`](packages/scout/examples/compare.ts) - **Sign in.** "Sign in with these details and read the welcome message." [`login.ts`](packages/scout/examples/login.ts) - **On the cloud.** The research task on Outcrawl's cloud, with a link to watch the replay. [`outcrawl.ts`](packages/scout/examples/outcrawl.ts) Want the answer in a fixed shape, such as a list of names and prices? Pass a JSON Schema with the task and the answer comes back in exactly that shape. ## Bring your own models

使用方式

通过 npm 安装包，在代码中创建 Scout 实例并调用 run 方法执行任务，支持本地浏览器或 Outcrawl 云浏览器。

查看 README 依据

**1. Install Scout.** You need Node 22 or later. On the cloud there is no browser to install. ```sh npm i @outcrawl/scout ``` **2. Add your keys.** An Outcrawl key for the browser ([get one free at outcrawl.ai](https://outcrawl.ai): 1,000 credits every month, no card needed) and a key for your model. Scout works with any AI model service that speaks the standard chat completions API, including a model running on your own computer: ```sh export OUTCRAWL_API_KEY=your-outcrawl-key export SCOUT_BASE_URL=https://your-endpoint/v1 export SCOUT_API_KEY=your-model-key

export SCOUT_HANDS_MODEL=your-model-id ``` **3. Give it a task.** Save this as `task.ts` and run `npx tsx task.ts`: ```ts import { Scout } from '@outcrawl/scout'; const scout = new Scout({ browser: 'outcrawl', models: { hands: { model: process.env.SCOUT_HANDS_MODEL!, baseURL: process.env.SCOUT_BASE_URL!, apiKey: process.env.SCOUT_API_KEY!, }, }, }); const result = await scout.run('Find the top three stories on Hacker News right now'); console.log(result.data); console.log(result.replayUrl); // watch the whole run, step by step ```

部署要求

需要 Node 22 或更高版本，以及 Outcrawl API 密钥（每月免费 1000 积分）和模型 API 密钥。

查看 README 依据

<img alt="TypeScript, Node 22 or later" src="https://img.shields.io/badge/TypeScript-Node%2022%2B-ede8fc?style=flat-square&labelColor=1a1815"> </p> # Tell it the task. It opens a browser and gets it done. Scout is an open-source agent that uses a real browser to finish a task for you. Describe what you need in plain words. Scout reads the page, clicks, types and scrolls until the job is done, then hands back the answer. If it cannot finish, it tells you what is missing and returns what it found.

**1. Install Scout.** You need Node 22 or later. On the cloud there is no browser to install. ```sh npm i @outcrawl/scout ``` **2. Add your keys.** An Outcrawl key for the browser ([get one free at outcrawl.ai](https://outcrawl.ai): 1,000 credits every month, no card needed) and a key for your model. Scout works with any AI model service that speaks the standard chat completions API, including a model running on your own computer: ```sh export OUTCRAWL_API_KEY=your-outcrawl-key export SCOUT_BASE_URL=https://your-endpoint/v1 export SCOUT_API_KEY=your-model-key

已知限制

在本地浏览器运行时，replayUrl 为空；若模型服务不支持结构化回复，需要调整 structuredOutput 设置。

查看 README 依据

Scout opens a browser on Outcrawl's cloud, works through the page, and prints the answer with a link to the replay. **Rather use a browser on your own machine?** Install one with `npm i playwright-core && npx playwright install chromium`, then change the one line to `browser: { launch: {} }`. Add `headless: false` inside `launch` to watch it work. Replays come with the cloud, so `replayUrl` stays empty on your own browser. > [!TIP] > Not writing the code yourself? Give this page to your coding agent and ask it to set Scout up and run your task. ## What you can ask it to do

If a service refuses Scout's request for a structured reply, the run's error says which job it was and what to change: set `structuredOutput` on that job to `'json_object'` or `'strict'`. ## The best way to run it: Outcrawl's cloud <p> <picture> <source media="(prefers-color-scheme: dark)" srcset=".github/assets/figure-dark.png"> <source media="(prefers-color-scheme: light)" srcset=".github/assets/figure-light.png"> <img alt="Your agent on the left reaches a browser on your own laptop, or a browser on Outcrawl's cloud on the right." src=".github/assets/figure-light.png" width="100%">