Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.scrapegraphai.com/llms.txt

Use this file to discover all available pages before exploring further.

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

npm install -g just-scrape
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

VariableDescriptionDefault
SGAI_API_KEYScrapeGraph API key—
SGAI_API_URLOverride API base URLhttps://api.scrapegraphai.com/api/v2
SGAI_TIMEOUTRequest timeout in seconds120
SGAI_DEBUGSet to 1 to log requests/responses—
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

just-scrape credits    # check your credit balance

​
Quick start

just-scrape extract https://news.ycombinator.com \
  -p "Extract the top 5 story titles and their URLs"

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