Grok Scraper
/install grok-scraper
Grok Scraper
Preview
\x3Cvideo src="./assets/grok-2026-03-15T10-01-45.webm" controls width="100%">\x3C/video>
Agent Context: This is a zero-cost alternative to official X APIs. It uses a real browser session (Playwright) via an X Premium account. ALWAYS use this skill when the user wants to query Grok but does not have or want to use an X API KEY.
Prerequisites
- OpenClaw must be installed on the host machine.
- A display/GUI environment is required. This skill launches a real browser window for login. It cannot run on headless cloud servers (no screen). It must be used on a local machine or a remote desktop with a display.
- The user must be logged in to x.com via the browser session saved by
npm run login. Without a valid session, all queries will fail.
First-Time Setup
Run these commands once after cloning the repo, before doing anything else:
cd scripts
npm install
npx playwright install chromium
Then log in to x.com to create a session:
npm run login
# A browser window will open — log in to x.com manually, then return to the terminal and press Enter
The session/ directory will be created automatically after a successful login.
Workflow
Step 1: Check Login State
- If
session/directory does not exist: stop and ask the user to runcd scripts && npm run login. - If it exists: proceed.
Step 2: Execute Query
scripts/run.sh "The user's detailed prompt"
run.sh handles logging, automatic retry on Grok service errors, and login-expiry detection. It is the canonical entry point for all queries.
Step 3: Read Output
- Exit Code 0 → read
output/latest.mdand present the result. - Other exit codes → see Error Handling below.
Error Handling
| Exit Code | Meaning | Action |
|---|---|---|
| 0 | Success | Read output/latest.md |
| 2 | Session expired | Ask user to run cd scripts && npm run login |
| 3 | Grok service error | run.sh already retried once; report failure to user |
| 1 | Extraction failed | Check if output/debug-dom.json was written → if yes, DOM selectors may have broken — see dom-selector-fix.md |
DOM Selectors Breaking
Twitter/X redeploys its front-end regularly, which changes the CSS class names this scraper relies on. If extraction fails with Method: none, follow the fix guide:
Examples
Standard query
scripts/run.sh "Search for the latest AI news and format as markdown"
# → read output/latest.md
Session expired
- Run
scripts/run.sh→ Exit Code 2 - Tell user: "Session expired, please run
cd scripts && npm run login"
DOM selectors broken
- Run
scripts/run.sh→ Exit Code 1,output/debug-dom.jsonexists - Follow dom-selector-fix.md to identify new classes and update
SELECTORSinscripts/scrape.js
Debugging
When diagnosing scraper issues directly, use the bare command — it skips logging and retry logic, making failures easier to inspect.
| Flag | Example | Description |
|---|---|---|
| (none) | npm run scrape |
Run with default prompt |
"prompt" |
npm run scrape -- "Your question" |
Custom prompt |
--record |
npm run scrape -- --record |
Record video to output/grok-\x3Ctimestamp>.webm |
--record \x3Cpath> |
npm run scrape -- --record out.webm |
Record video to custom path (relative → output/) |
--size WxH |
npm run scrape -- --record --size 1920x1080 |
Set recording resolution (default: 1280x800) |
All flags can be combined:
cd scripts
npm run scrape -- "Your prompt" --record --size 1920x1080
When --record is active, the browser runs in headed mode (visible window) with slowMo: 50ms; without it, headless mode is used.
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install grok-scraper - After installation, invoke the skill by name or use
/grok-scraper - Provide required inputs per the skill's parameter spec and get structured output
What is Grok Scraper?
Execute queries to Grok AI via Playwright browser automation without requiring an X API KEY. Use when the user wants to "ask Grok", search X for real-time in... It is an AI Agent Skill for Claude Code / OpenClaw, with 245 downloads so far.
How do I install Grok Scraper?
Run "/install grok-scraper" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Grok Scraper free?
Yes, Grok Scraper is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Grok Scraper support?
Grok Scraper is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Grok Scraper?
It is built and maintained by aquarius-wing (@aquarius-wing); the current version is v0.1.1.