Naar hoofdinhoud gaan
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 zelfstandige 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 dan 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
Draaien zonder globale installatie:
npx -y olostep-cli@latest --help
Platforms: macOS (Apple Silicon en Intel), Linux x64, Windows x64.

API-sleutel

Stel OLOSTEP_API_KEY in je omgeving in, of in een .env bestand in de directory waar je olostep uitvoert. Maak sleutels aan: Olostep API Keys.
export OLOSTEP_API_KEY=your_key_here
olostep --help

Uitvoer

VlagGedrag
--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.
Voortgangs- en logregels gaan naar stderr, zodat stdout parseerbaar blijft.
olostep map "https://example.com" --top-n 20 --out - | jq '.urls[:10]'
olostep scrape "https://example.com" --out - | jq .result.markdown_content
Als je --out weglaat, worden bestanden geplaatst onder 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

OptieBeschrijving
--outBestandspad of -
--top-nMaximaal aantal URL’s
--search-queryLeid ontdekking
--include-subdomain / --no-include-subdomainSubdomeinen
--include-url / --exclude-urlHerhaalbare patronen
--cursorPaginering
Gebruik --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.
OptieBeschrijving
--outBestand of -
--json-formatOptionele gestructureerde uitvoer hint (JSON object string)
--poll-interval / --poll-timeoutPolling (seconden)
Gebruik --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).
OptieBeschrijving
--formatsKomma-gescheiden
--countryLandcode
--wait-before-scrapingMs om te wachten voor scrape
--payload-jsonGeavanceerde opties als JSON object string
--payload-fileHetzelfde, 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.
OptieBeschrijving
--formatsmarkdown, html, json
--countryOptioneel
--parser-idGestructureerde extractie parser
--poll-seconds, --log-every, --items-limitPolling / paginering
--dry-runAlleen payload printen
olostep batch-scrape urls.csv --formats markdown,html

batch-update: batch metadata

Vereist één van --metadata-json of --metadata-file (JSON object).
olostep batch-update "batch_abc123" --metadata-json '{"team":"growth"}'

Standaard --out paden

Wanneer --out wordt weggelaten:
CommandoStandaard
mapoutput/map.json
answeroutput/answer.json
scrapeoutput/scrape.json
scrape-getoutput/scrape_get.json
crawloutput/crawl_results.json
batch-scrapeoutput/batch_results.json
batch-updateoutput/batch_update.json

Globale vlaggen

VlagBeschrijving
-V, --versionVersie
-h, --helpHelp

Gerelateerde documentatie

Repository: github.com/olostep-api/CLI

Beveiliging

Houd API-sleutels uit versiebeheer; roteer als ze gelekt zijn.