CLI integration

Check the installation and extract a page

Set GEONODE_SCRAPER_API_KEY through your environment or the CLI config file. Run the commands below after installation. Avoid putting a real key into command-line flags or committed files.

gscraper --help
gscraper extract https://example.com --format markdown

The help command lists the available commands. A successful extraction prints a readable result; use --json when a script needs the structured response.

Use the result in a script

Read ok before consuming result.data.markdown. Failures include an error object with status, code, message and retryable. The CLI also provides exit codes so scripts can detect failure without parsing a human-readable message.

gscraper extract https://example.com --format markdown --json

Run larger jobs

Replace JOB_ID with the ID returned by the batch command. Use per-command --help to inspect timeout and polling options before putting a command into a scheduled workflow.

gscraper map run https://example.com --search pricing
gscraper batch create https://example.com https://example.org --format markdown
gscraper batch wait JOB_ID
gscraper usage concurrency

Resolve configuration problems

Flags override environment variables, which override the config file. Use gscraper config path to locate the TOML file and gscraper config show to inspect settings with keys masked. If the command is missing on Windows, check the Python Scripts directory on PATH or install through pipx.