olostep te draaien.
Bij installatie downloadt een postinstall-stap de bijpassende binary van de GitHub releases van het pakket. Als dat mislukt, controleer dan of er een release bestaat voor deze pakketversie en jouw platform, en installeer dan opnieuw.
Installeren
Vereisten: Node.js 16+ (alleen voornpm / npx; de CLI zelf is een native binary).
API-sleutel
StelOLOSTEP_API_KEY in je omgeving in, of in een .env bestand in de directory waar je olostep uitvoert.
Maak sleutels aan: Olostep API Keys.
Uitvoer
| Vlag | Gedrag |
|---|---|
--out <pad> | Schrijf JSON naar een bestand (bovenliggende mappen worden aangemaakt indien nodig). |
--out - | Schrijf JSON alleen naar stdout (UTF-8, ingesprongen). Goed voor pipes en subprocess capture. |
--out weglaat, worden bestanden geplaatst onder output/ (zie Standaard --out paden).
Commando’s
Gebruikolostep <commando> --help voor elke optie. De meeste commando’s accepteren --timeout (HTTP, seconden).
map: ontdek URL’s
| Optie | Beschrijving |
|---|---|
--out | Bestandspad of - |
--top-n | Maximaal aantal URL’s |
--search-query | Leid ontdekking |
--include-subdomain / --no-include-subdomain | Subdomeinen |
--include-url / --exclude-url | Herhaalbare patronen |
--cursor | Paginering |
--top-n, niet --limit (verwijderd).
answer: onderzocht antwoord
Vraagt totdat het antwoord klaar is.
| Optie | Beschrijving |
|---|---|
--out | Bestand of - |
--json-format | Optionele gestructureerde uitvoer hint (JSON object string) |
--poll-interval / --poll-timeout | Polling (seconden) |
--json-format, niet --model (verwijderd).
scrape: één URL
Formaten: html, markdown, text, json, raw_pdf, screenshot (komma-gescheiden; standaard markdown).
| Optie | Beschrijving |
|---|---|
--formats | Komma-gescheiden |
--country | Landcode |
--wait-before-scraping | Ms om te wachten voor scrape |
--payload-json | Geavanceerde opties als JSON object string |
--payload-file | Hetzelfde, uit bestand (niet samen met --payload-json) |
scrape-get: door scrape ID
crawl: site crawl
Ophalen formaten: markdown, html, json.
Opmerkelijke vlaggen: --max-pages, --max-depth, --include-subdomain, --include-external, --include-url, --exclude-url, --search-query, --top-n, --webhook, --crawl-timeout, --follow-robots-txt / --ignore-robots-txt, --formats, --pages-limit, --pages-search-query, --poll-seconds, --poll-timeout, --dry-run (print payload, geen verzoek).
batch-scrape: CSV
CSV kolommen: custom_id of id, en url.
| Optie | Beschrijving |
|---|---|
--formats | markdown, html, json |
--country | Optioneel |
--parser-id | Gestructureerde extractie parser |
--poll-seconds, --log-every, --items-limit | Polling / paginering |
--dry-run | Alleen payload printen |
batch-update: batch metadata
Vereist één van --metadata-json of --metadata-file (JSON object).
Standaard --out paden
Wanneer --out wordt weggelaten:
| Commando | Standaard |
|---|---|
map | output/map.json |
answer | output/answer.json |
scrape | output/scrape.json |
scrape-get | output/scrape_get.json |
crawl | output/crawl_results.json |
batch-scrape | output/batch_results.json |
batch-update | output/batch_update.json |
Globale vlaggen
| Vlag | Beschrijving |
|---|---|
-V, --version | Versie |
-h, --help | Help |