Skip to main content
All just-scrape commands support --json for machine-readable output. When set:
  • The ASCII banner is hidden
  • Spinners and progress indicators are suppressed
  • Interactive prompts are disabled
  • Only minified JSON is written to stdout
This makes just-scrape easy to use in shell scripts, CI pipelines, and AI agent workflows.

Usage

just-scrape <command> [args] --json

Examples

Save results to a file

just-scrape smart-scraper https://store.example.com \
  -p "Extract all product names and prices" \
  --json > products.json

Extract a specific field with jq

just-scrape credits --json | jq '.remaining_credits'

just-scrape sitemap https://example.com --json | jq -r '.urls[]'

just-scrape history smartscraper --json | jq '.requests[] | {id: .request_id, status}'

Convert a page to markdown and save it

just-scrape markdownify https://docs.example.com/api \
  --json | jq -r '.result' > api-docs.md

Chain commands in a shell script

#!/bin/bash
while IFS= read -r url; do
  just-scrape smart-scraper "$url" \
    -p "Extract the page title and main content" \
    --json >> results.jsonl
done < urls.txt

Response structure

FieldDescription
resultExtracted data or markdown content
statusJob status: completed or failed
request_idUnique ID for the request
errorError message if the request failed
Credits response:
{
  "remaining_credits": 4820,
  "total_credits": 5000
}
--json is especially useful when calling just-scrape from AI coding agents — it eliminates decorative output and saves tokens.