Examples

const scout = new Scout({ browser: { launch: {} }, models: modelsFromEnv() });

const result = await scout.run(
  'Go to https://news.ycombinator.com and report the three stories with the most comments on the front page: ' +
    'title, link and comment count for each.',
  {
    caps: { steps: 15, duration: '8m' },
    schema: { /* stories: [{ title, url, comments }], at most 3 */ },
    onStep: (step) => console.log(`step ${String(step.index)}: ${step.action.description}`),
  },
);

const result = await scout.run(
  'Open https://httpbin.org/forms/post and order a pizza: customer name Ada Lovelace, telephone 555-0100, ' +
    'email ada@example.com, size Large, toppings Bacon and Extra Cheese, delivery time 19:30, ' +
    'delivery instructions "Ring twice". Submit the order, then report the customer name, size and toppings ' +
    'exactly as the page that loads after submitting shows them.',
  {
    caps: { steps: 25, duration: '10m' },
    schema: { /* customer, size, toppings */ },
  },
);

const result = await scout.run(
  'On https://books.toscrape.com find the books "A Light in the Attic" and "Tipping the Velvet". ' +
    "Open each book's own page and report its price and how many copies are in stock, then say which is cheaper.",
  {
    caps: { steps: 30, duration: '15m' },
    // One named field per book rather than a list: Scout merges what each page
    // gives it field by field, so the first book's details survive while it
    // reads the second book's page. A list is replaced whole by each new read.
    schema: { /* lightInTheAttic, tippingTheVelvet, cheaper */ },
  },
);

const username = process.env['DEMO_USERNAME'] ?? 'student';
const password = process.env['DEMO_PASSWORD'] ?? 'Password123';

const result = await scout.run(
  `Go to https://practicetestautomation.com/practice-test-login/ and sign in with username "${username}" and ` +
    `password "${password}". Once you are signed in, extract the heading and the message of the page that welcomes you.`,
  {
    caps: { steps: 25, duration: '10m' },
    schema: { /* heading, message */ },
  },
);

// Reads OUTCRAWL_API_KEY. Pass { outcrawl: { apiKey, proxy, record } } to set them in code.
const scout = new Scout({ browser: 'outcrawl', models: modelsFromEnv() });

const result = await scout.run(/* the research task and schema */);

console.log(result.status, result.stopReason);
console.log(JSON.stringify(result.data, null, 2));
console.log('watch the run:', result.replayUrl ?? '(not recorded)');