Skip to main content
NPM package: olostep-cli CLI for the Olostep API: map, answer, scrape, scrape-get, crawl, batch-scrape, and batch-update. Responses are JSON (pretty-printed) for scripts, CI, and agents. Installing this package downloads a standalone binary for your OS. You do not need Python to run olostep.
On install, a postinstall step downloads the matching binary from the package’s GitHub releases. If that fails, confirm a release exists for this package version and your platform, then reinstall.

​
Install

Requirements: Node.js 16+ (only for npm / npx; the CLI itself is a native binary). 
npm install -g olostep-cli
Run without a global install: 
npx -y olostep-cli@latest --help
Platforms: macOS (Apple Silicon and Intel), Linux x64, Windows x64.

​
API key

Set OLOSTEP_API_KEY in your environment, or in a .env file in the directory where you run olostep. Create keys: Olostep API Keys. 
export OLOSTEP_API_KEY=your_key_here
olostep --help

​
Output

FlagBehavior
--out <path>Write JSON to a file (parent dirs created if needed).
--out -Write JSON to stdout only (UTF-8, indented). Good for pipes and subprocess capture.
Progress and log lines go to stderr, so stdout stays parseable. 
olostep map "https://example.com" --top-n 20 --out - | jq '.urls[:10]'
olostep scrape "https://example.com" --out - | jq .result.markdown_content
If you omit --out, files go under output/ (see Default --out paths).

​
Commands

Use olostep <command> --help for every option. Most commands accept --timeout (HTTP, seconds).

​
map: discover URLs

OptionDescription
--outFile path or -
--top-nMax URLs
--search-queryGuide discovery
--include-subdomain / --no-include-subdomainSubdomains
--include-url / --exclude-urlRepeatable patterns
--cursorPagination
Use --top-n, not --limit (removed). 
olostep map "https://example.com" --top-n 100 --search-query "blog"

​
answer: researched answer

Polls until the answer is ready.
OptionDescription
--outFile or -
--json-formatOptional structured output hint (JSON object string)
--poll-interval / --poll-timeoutPolling (seconds)
Use --json-format, not --model (removed). 
olostep answer "What does this company build?" --out answer.json
olostep answer "Extract facts" --json-format '{"company":"","year":""}' --out -

​
scrape: one URL

Formats: html, markdown, text, json, raw_pdf, screenshot (comma-separated; default markdown).
OptionDescription
--formatsComma-separated
--countryCountry code
--wait-before-scrapingMs to wait before scrape
--payload-jsonAdvanced options as JSON object string
--payload-fileSame, from file (not together with --payload-json)
olostep scrape "https://example.com" --formats markdown,html
olostep scrape "https://example.com" --payload-file scrape-options.json --out -

​
scrape-get: by scrape ID

olostep scrape-get "scrape_abc123" --out -

​
crawl: site crawl

Retrieve formats: markdown, html, json. Notable flags: --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, no request). 
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 columns: custom_id or id, and url.
OptionDescription
--formatsmarkdown, html, json
--countryOptional
--parser-idStructured extraction parser
--poll-seconds, --log-every, --items-limitPolling / paging
--dry-runPrint payload only
olostep batch-scrape urls.csv --formats markdown,html

​
batch-update: batch metadata

Requires one of --metadata-json or --metadata-file (JSON object). 
olostep batch-update "batch_abc123" --metadata-json '{"team":"growth"}'

​
Default --out paths

When --out is omitted:
CommandDefault
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

​
Global flags

FlagDescription
-V, --versionVersion
-h, --helpHelp
Repository: github.com/olostep-api/CLI

​
Security

Keep API keys out of source control; rotate if leaked.