Docs
Open SmallForce

CLI

smallforce scrapers run

Reserve credits and submit one asynchronous scraper run

This page is generated from the same Commander definition shipped in SmallForce CLI 0.1.11. Run smallforce scrapers run --help locally to view the same reference for your installed version.

Complete command help

Usage: smallforce scrapers run [options] <scraperId>

Reserve credits and submit one asynchronous scraper run

Arguments:
  scraperId            UUID returned by scrapers search

Options:
  --input <json>       Scraper input JSON matching inputSchema
  --input-file <path>  Scraper input JSON file; use - to read from stdin
  --max-credits <n>    Maximum SmallForce Credits this run may consume
  --api-key <key>      SmallForce API key, or set SMALLFORCE_API_KEY
  --backend-url <url>  SmallForce backend URL, or set SMALLFORCE_BACKEND_URL
  --json               Print stable machine-readable JSON
  --text               Print human-readable text
  --format <format>    Output format: text or json
  -h, --help           display help for command