Skip to main content
just-scrape is the official CLI for ScrapeGraph AI — AI-powered web scraping, data extraction, search, and crawling, straight from your terminal.
Get your API key from the dashboard

​
Installation

Package: just-scrape on npm | GitHub

​
Configuration

The CLI needs a ScrapeGraph API key. Four ways to provide it (checked in order):
  1. Environment variable: export SGAI_API_KEY="sgai-..."
  2. .env file: SGAI_API_KEY=sgai-... in project root
  3. Config file: ~/.scrapegraphai/config.json
  4. Interactive prompt: the CLI asks and saves to config

​
Environment Variables

Legacy variables are still bridged transparently: JUST_SCRAPE_API_URL → SGAI_API_URL, JUST_SCRAPE_TIMEOUT_S and SGAI_TIMEOUT_S → SGAI_TIMEOUT, JUST_SCRAPE_DEBUG → SGAI_DEBUG.

​
Verify your setup

​
Quick start

Commands

Full reference for every command and its flags

JSON Mode

Machine-readable output for scripting and AI agents

AI Agent Skill

Install just-scrape as a coding agent skill

Examples

Practical examples for every command