Skip to main content
Every just-scrape command supports a --json flag that switches to machine-readable output. When active:
  • 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.

Basic usage

Examples

Save results to a file

Extract a specific field with jq

Convert a page to markdown and save it

Chain commands in a script

Use in a CI pipeline

Response structure

The JSON output mirrors the v2 API response for each command. Common shapes:
  • extract{ id, json, raw, usage, metadata }
  • scrape{ id, results: { markdown: { data: [...] }, ... }, metadata }
  • search{ id, results: [...], json, metadata }
  • crawl — the CLI polls until the job reaches a terminal state, then prints { id, status, finished, total, ... }
  • credits{ remaining, used, plan, jobs: { crawl: {used, limit}, monitor: {used, limit} } }
  • validate{ status, uptime }
For credits:
--json mode is especially useful when calling just-scrape from AI coding agents. It eliminates decorative output and saves tokens.