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.
Paquete NPM: olostep-cli
CLI para la API de Olostep: map, answer, scrape, scrape-get, crawl, batch-scrape y batch-update. Las respuestas son JSON (impresas de manera 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 existe 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
npx -y olostep-cli@latest --help
Clave API
Configura OLOSTEP_API_KEY en tu entorno, o en un archivo .env en el directorio donde ejecutas olostep.
Crea claves: Claves API de Olostep.
export OLOSTEP_API_KEY=tu_clave_aquí
olostep --help
Salida
| Bandera | Comportamiento |
|---|
--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. |
olostep map "https://example.com" --top-n 20 --out - | jq '.urls[:10]'
olostep scrape "https://example.com" --out - | jq .result.markdown_content
--out, los archivos van bajo output/ (ver Rutas predeterminadas de --out).
Comandos
Usa olostep <command> --help para cada opción. La mayoría de los comandos aceptan --timeout (HTTP, segundos).
map: descubrir URLs
| Opción | Descripción |
|---|
--out | Ruta de archivo o - |
--top-n | Máximo de URLs |
--search-query | Guía de descubrimiento |
--include-subdomain / --no-include-subdomain | Subdominios |
--include-url / --exclude-url | Patrones repetibles |
--cursor | Paginación |
--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ón | Descripción |
|---|
--out | Archivo o - |
--json-format | Sugerencia opcional de salida estructurada (cadena de objeto JSON) |
--poll-interval / --poll-timeout | Consulta (segundos) |
--json-format, no --model (eliminado).
olostep answer "¿Qué construye esta empresa?" --out answer.json
olostep answer "Extraer hechos" --json-format '{"company":"","year":""}' --out -
scrape: una URL
Formatos: html, markdown, text, json, raw_pdf, screenshot (separados por comas; por defecto markdown).
| Opción | Descripción |
|---|
--formats | Separados por comas |
--country | Código de país |
--wait-before-scraping | Ms para esperar antes de scrape |
--payload-json | Opciones avanzadas como cadena de objeto JSON |
--payload-file | Lo 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 del sitio
Recuperar formatos: markdown, html, json.
Banderas 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ón | Descripción |
|---|
--formats | markdown, html, json |
--country | Opcional |
--parser-id | Analizador de extracción estructurada |
--poll-seconds, --log-every, --items-limit | Consulta / paginación |
--dry-run | Solo imprimir carga útil |
olostep batch-scrape urls.csv --formats markdown,html
--metadata-json o --metadata-file (objeto JSON).
olostep batch-update "batch_abc123" --metadata-json '{"team":"growth"}'
Rutas predeterminadas de --out
Cuando se omite --out:
| Comando | Predeterminado |
|---|
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 |
Banderas globales
| Bandera | Descripción |
|---|
-V, --version | Versión |
-h, --help | Ayuda |
Documentación relacionada
Repositorio: github.com/olostep-api/CLI
Seguridad
Mantén las claves API fuera del control de versiones; rota si se filtran.
