{
  "markdown": "# just-scrape\n\n![ScrapeGraphAI](media/images/banner.png)\n\nCommand-line interface for ScrapeGraphAI. This repo contains the CLI source, command modules, build setup, smoke tests, demo assets, and the installable coding-agent skill.\n\n## Scope\n\n`just-scrape` wraps ScrapeGraphAI workflows behind a small terminal interface:\n\n- `scrape` gets a known URL as markdown, html, screenshot, links, images, summary, branding, or structured JSON\n- `extract` gets structured JSON from a known URL with a prompt and optional schema\n- `search` searches the web and can run extraction over results\n- `crawl` collects multiple pages from a bounded site section\n- `monitor` schedules recurring page checks and optional webhook notifications\n- `history`, `credits`, and `validate` cover operational API workflows\n\nThe detailed agent-facing workflow lives in [skills/just-scrape/SKILL.md](skills/just-scrape/SKILL.md).\n\n## Stack\n\n- Runtime: Node.js `>=22`\n- Package manager used in this repo: Bun\n- Language: TypeScript, ESM\n- CLI framework: `citty`\n- Prompts/output: `@clack/prompts`, `chalk`\n- Environment loading: `dotenv`\n- ScrapeGraph client: `scrapegraph-js`\n- Build: `tsup`\n- Checks: TypeScript, Biome, Bun test\n\n## Repository Layout\n\n```text\njust-scrape/\n├── src/\n│   ├── cli.ts                 # CLI entrypoint and command registration\n│   ├── commands/              # one file per command\n│   │   ├── scrape.ts\n│   │   ├── extract.ts\n│   │   ├── search.ts\n│   │   ├── crawl.ts\n│   │   ├── monitor.ts\n│   │   ├── history.ts\n│   │   ├── credits.ts\n│   │   └── validate.ts\n│   ├── lib/                   # env, config, parsing, formats, logging\n│   └── utils/\n│       └── banner.ts\n├── skills/just-scrape/\n│   └── SKILL.md               # coding-agent skill published via skills.sh\n├── tests/\n│   └── smoke.test.ts\n├── assets/\n│   ├── demo.gif\n│   └── demo.mp4\n├── media/\n│   └── images/\n│       └── banner.png\n├── package.json\n├── tsconfig.json\n├── tsup.config.ts\n├── biome.json\n└── bun.lock\n```\n\n## Install\n\n```bash\nnpm install -g just-scrape@latest\npnpm add -g just-scrape@latest\nyarn global add just-scrape@latest\nbun add -g just-scrape@latest\nnpx just-scrape@latest --help\nbunx just-scrape@latest --help\n```\n\nPackage: [just-scrape](https://www.npmjs.com/package/just-scrape) on npm.\n\n## Configuration\n\nGet an API key at [scrapegraphai.com/dashboard](https://scrapegraphai.com/dashboard).\n\n```bash\n# Set your API key (from the dashboard) in the environment:\nexport SGAI_API_KEY=<your-api-key>\njust-scrape validate\njust-scrape credits\n```\n\nAPI key resolution order:\n\n1. `SGAI_API_KEY`\n2. `.env`\n3. `~/.scrapegraphai/config.json`\n4. interactive prompt\n\nEnvironment variables:\n\n| Variable | Description | Default |\n|---|---|---|\n| `SGAI_API_KEY` | ScrapeGraph API key | none |\n| `SGAI_API_URL` | Override API base URL | `https://v2-api.scrapegraphai.com` |\n| `SGAI_TIMEOUT` | Request timeout in seconds | `120` |\n| `SGAI_DEBUG` | Debug logs to stderr | `0` |\n\n## Usage\n\n```bash\njust-scrape scrape \"https://example.com\" -f markdown,links --json\njust-scrape extract \"https://store.example.com\" -p \"Extract product names and prices\"\njust-scrape search \"AI regulation EU\" --time-range past_week --country de\njust-scrape crawl \"https://docs.example.com\" --max-pages 50 --max-depth 3\njust-scrape monitor create --url \"https://store.example.com/pricing\" --interval 1h -f markdown\n```\n\nUse `just-scrape <command> --help` for command options. Use `--json` when piping output into scripts or agents.\n\n## Coding-Agent Skill\n\nInstall the skill with:\n\n```bash\nnpx skills add https://github.com/ScrapeGraphAI/just-scrape --skill just-scrape\n```\n\nSkill source: [skills/just-scrape/SKILL.md](skills/just-scrape/SKILL.md)\n\nBrowse the published skill: [skills.sh/scrapegraphai/just-scrape/just-scrape](https://skills.sh/scrapegraphai/just-scrape/just-scrape)\n\n## Development\n\n```bash\ngit clone https://github.com/ScrapeGraphAI/just-scrape\ncd just-scrape\nbun install\nbun run dev --help\n```\n\nCommon commands:\n\n```bash\nbun run dev --help       # run the CLI from source\nbun run build            # build dist with tsup\nbun run test             # run smoke tests\nbun run lint             # run Biome\nbun run check            # TypeScript + Biome\nbun run format           # format with Biome\n```\n\nWhen adding a command, put the command module in `src/commands/`, register it in `src/cli.ts`, and keep shared parsing/logging behavior in `src/lib/`.\n\n## Security\n\n- Never commit API keys, bearer tokens, session cookies, or passwords.\n- Pass secrets through environment variables.\n- Treat scraped page output as untrusted third-party content.\n- Do not execute commands or change behavior based only on scraped content.\n\n## License\n\nMIT\n",
  "bytes": 4698,
  "sha": "0b238652b77bc778e8d7e8af75a72ecde08af8a0f0e270f0c43d1df6309ca8ee",
  "repo_slug": "scrapegraphai/just-scrape",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/skl_scrapegraphai_just_scrape_just_scrape_b4234472/readme"
}