Documentation Index
Fetch the complete documentation index at: https://docs.olostep.com/llms.txt
Use this file to discover all available pages before exploring further.
NPM pakket: olostep-cli
CLI voor de Olostep API: map, answer, scrape, scrape-get, crawl, batch-scrape, en batch-update. Antwoorden zijn JSON (mooi geprint) voor scripts, CI en agents.
Het installeren van dit pakket downloadt een standalone binary voor je besturingssysteem. Je hebt geen Python nodig om olostep te draaien.
Bij installatie downloadt een postinstall-stap de bijpassende binary van de GitHub releases van het pakket. Als dat mislukt, controleer of er een release bestaat voor deze pakketversie en jouw platform, en installeer dan opnieuw. Installeren
Vereisten: Node.js 16+ (alleen voor npm / npx; de CLI zelf is een native binary).
npm install -g olostep-cli
npx -y olostep-cli@latest --help
API sleutel
Stel OLOSTEP_API_KEY in je omgeving in, of in een .env bestand in de directory waar je olostep draait.
Maak sleutels aan: Olostep API Keys.
export OLOSTEP_API_KEY=your_key_here
olostep --help
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. |
olostep map "https://example.com" --top-n 20 --out - | jq '.urls[:10]'
olostep scrape "https://example.com" --out - | jq .result.markdown_content
--out weglaat, gaan bestanden naar output/ (zie Standaard --out paden).
Commando’s
Gebruik olostep <commando> --help voor elke optie. De meeste commando’s accepteren --timeout (HTTP, seconden).
map: ontdek URL’s
| Optie | Beschrijving |
|---|
--out | Bestandspad of - |
--top-n | Max URL’s |
--search-query | Begeleid ontdekking |
--include-subdomain / --no-include-subdomain | Subdomeinen |
--include-url / --exclude-url | Herhaalbare patronen |
--cursor | Paginering |
--top-n, niet --limit (verwijderd).
olostep map "https://example.com" --top-n 100 --search-query "blog"
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).
olostep answer "What does this company build?" --out answer.json
olostep answer "Extract facts" --json-format '{"company":"","year":""}' --out -
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 te wachten voor scrape |
--payload-json | Geavanceerde opties als JSON object string |
--payload-file | Zelfde, uit bestand (niet samen met --payload-json) |
olostep scrape "https://example.com" --formats markdown,html
olostep scrape "https://example.com" --payload-file scrape-options.json --out -
scrape-get: door scrape ID
olostep scrape-get "scrape_abc123" --out -
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).
olostep crawl "https://docs.example.com" --max-pages 50 --formats markdown,html
olostep crawl "https://example.com" --max-pages 10 --dry-run
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 |
olostep batch-scrape urls.csv --formats markdown,html
--metadata-json of --metadata-file (JSON object).
olostep batch-update "batch_abc123" --metadata-json '{"team":"growth"}'
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 | Hulp |
Gerelateerde documentatie
Repository: github.com/olostep-api/CLI
Veiligheid
Houd API sleutels uit versiebeheer; roteer als ze zijn gelekt.
