Saltar al contenido principal
Paquete NPM: olostep-cli CLI para la Olostep API: map, answer, scrape, scrape-get, crawl, batch-scrape y batch-update. Las respuestas son JSON (impresas de forma legible) para scripts, CI y agentes. Instalar este paquete descarga un binario independiente para tu sistema operativo. No necesitas Python para ejecutar olostep.
Al instalar, un paso postinstalación descarga el binario correspondiente desde los lanzamientos de GitHub del paquete. Si eso falla, confirma que exista un lanzamiento para esta versión del paquete y tu plataforma, luego reinstala.

​
Instalación

Requisitos: Node.js 16+ (solo para npm / npx; el CLI en sí es un binario nativo). 
npm install -g olostep-cli
Ejecutar sin una instalación global: 
npx -y olostep-cli@latest --help
Plataformas: macOS (Apple Silicon e Intel), Linux x64, Windows x64.

​
Clave API

Configura OLOSTEP_API_KEY en tu entorno, o en un archivo .env en el directorio donde ejecutas olostep. Crea claves: Olostep API Keys. 
export OLOSTEP_API_KEY=your_key_here
olostep --help

​
Salida

FlagComportamiento
--out <path>Escribe JSON en un archivo (se crean directorios padres si es necesario).
--out -Escribe JSON solo en stdout (UTF-8, con sangría). Bueno para pipes y captura de subprocesos.
Las líneas de progreso y registro van a stderr, por lo que stdout permanece analizable. 
olostep map "https://example.com" --top-n 20 --out - | jq '.urls[:10]'
olostep scrape "https://example.com" --out - | jq .result.markdown_content
Si omites --out, los archivos van bajo output/ (ver Rutas predeterminadas --out).

​
Comandos

Usa olostep <command> --help para cada opción. La mayoría de los comandos aceptan --timeout (HTTP, segundos).

​
map: descubrir URLs

OpciónDescripción
--outRuta de archivo o -
--top-nMáximo de URLs
--search-queryGuía de descubrimiento
--include-subdomain / --no-include-subdomainSubdominios
--include-url / --exclude-urlPatrones repetibles
--cursorPaginación
Usa --top-n, no --limit (eliminado). 
olostep map "https://example.com" --top-n 100 --search-query "blog"

​
answer: respuesta investigada

Consulta hasta que la respuesta esté lista.
OpciónDescripción
--outArchivo o -
--json-formatSugerencia opcional de salida estructurada (cadena de objeto JSON)
--poll-interval / --poll-timeoutSondeo (segundos)
Usa --json-format, no --model (eliminado). 
olostep answer "What does this company build?" --out answer.json
olostep answer "Extract facts" --json-format '{"company":"","year":""}' --out -

​
scrape: una URL

Formatos: html, markdown, text, json, raw_pdf, screenshot (separados por comas; por defecto markdown).
OpciónDescripción
--formatsSeparados por comas
--countryCódigo de país
--wait-before-scrapingMs para esperar antes de raspar
--payload-jsonOpciones avanzadas como cadena de objeto JSON
--payload-fileLo mismo, desde archivo (no junto con --payload-json)
olostep scrape "https://example.com" --formats markdown,html
olostep scrape "https://example.com" --payload-file scrape-options.json --out -

​
scrape-get: por ID de scrape

olostep scrape-get "scrape_abc123" --out -

​
crawl: rastreo de sitio

Recuperar formatos: markdown, html, json. Flags notables: --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 (imprimir carga útil, sin solicitud). 
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

Columnas CSV: custom_id o id, y url.
OpciónDescripción
--formatsmarkdown, html, json
--countryOpcional
--parser-idParser de extracción estructurada
--poll-seconds, --log-every, --items-limitSondeo / paginación
--dry-runSolo imprimir carga útil
olostep batch-scrape urls.csv --formats markdown,html

​
batch-update: metadatos por lotes

Requiere uno de --metadata-json o --metadata-file (objeto JSON). 
olostep batch-update "batch_abc123" --metadata-json '{"team":"growth"}'

​
Rutas predeterminadas --out

Cuando se omite --out:
ComandoPredeterminado
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

​
Flags globales

FlagDescripción
-V, --versionVersión
-h, --helpAyuda

​
Documentación relacionada

Repositorio: github.com/olostep-api/CLI

​
Seguridad

Mantén las claves API fuera del control de versiones; rota si se filtran.