> ## Documentation Index
> Fetch the complete documentation index at: https://www.octoparse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Octoparse CLI

> Usa Octoparse CLI para crear, ejecutar, gestionar, programar, inspeccionar, automatizar y exportar tareas en entornos locales o en la nube.

Octoparse CLI es una herramienta de línea de comandos para crear, ejecutar, gestionar, programar, inspeccionar y exportar tareas de Octoparse desde un terminal.

A diferencia de la aplicación de escritorio, está diseñada para flujos mediante scripts, pipelines de CI/CD, entornos de servidor y pipelines de datos automatizados.

## Qué permite hacer Octoparse CLI

<CardGroup cols={2}>
  <Card title="Crear tareas desde una URL" icon="wand-magic-sparkles" href="./cli/guides/detect">
    Inspecciona cualquier URL y genera un archivo de tarea local de forma automática, manual o mediante un flujo con un agente de IA.
  </Card>

  <Card title="Buscar y gestionar tareas" icon="magnifying-glass" href="./cli/guides/tasks-and-groups">
    Enumera tareas en la nube, busca por palabra clave, inspecciona detalles y trabaja con grupos de tareas.
  </Card>

  <Card title="Crear desde plantillas" icon="table-cells" href="./cli/guides/templates">
    Consulta y busca plantillas, crea Plantillas de tarea y modifícalas.
  </Card>

  <Card title="Ejecutar tareas localmente" icon="play" href="./cli/guides/local-runs">
    Ejecuta tareas con el motor local integrado y una instancia independiente de Chrome.
  </Card>

  <Card title="Elegir un modo de navegador" icon="window" href="./cli/guides/browser-modes">
    Usa una instancia independiente de Chrome o reutiliza un perfil de Chrome o Edge con la sesión iniciada.
  </Card>

  <Card title="Ejecutar y programar tareas en la nube" icon="calendar" href="./cli/guides/cloud-runs-and-schedules">
    Inicia la Extracción en la nube, revisa el historial y configura programaciones recurrentes.
  </Card>

  <Card title="Inspeccionar y exportar datos" icon="file-export" href="./cli/guides/data">
    Comprueba el número de registros, previsualiza filas, revisa datos no exportados y exporta resultados locales o en la nube.
  </Card>

  <Card title="Automatizar con agentes" icon="robot" href="./cli/guides/automation">
    Usa salidas JSON, flujos de eventos JSONL y códigos de salida para integrar la CLI en scripts y agentes de IA.
  </Card>
</CardGroup>

## Cómo funciona

Octoparse CLI ejecuta directamente el motor integrado de Octoparse para la Ejecución local. Usa una instancia independiente de Chrome y no requiere el cliente de escritorio Electron.

La Extracción en la nube se controla mediante API de backend; la Ejecución local, mediante el motor local.

<Note>
  Esta CLI registra el estado de las ejecuciones locales, que no se sincroniza con el cliente de escritorio de Octoparse.
</Note>

## Requisitos

Antes de usar Octoparse CLI, necesitas:

* Node.js 20 o posterior
* npm 8 o posterior
* Una cuenta de Octoparse (clave de API u OAuth)
* Acceso a las tareas que quieras ejecutar o exportar

Consulta [Instalación](./cli/quick-start/installation) para conocer los requisitos de cada plataforma y los pasos de configuración, incluidas las limitaciones de Linux arm64.

Los comandos funcionales requieren autenticación, incluidas las ejecuciones locales con `--task-file` y `.otd`. Los comandos de configuración y diagnóstico como `--help`, `--version`, `doctor`, `browser`, `capabilities` y `auth` pueden ejecutarse sin ella.

## Flujo habitual

<Steps>
  <Step title="Instalar Octoparse CLI">Instala globalmente la CLI con npm.</Step>

  <Step title="Autenticarse">
    Inicia sesión con OAuth o una clave de API de Octoparse. En CI, usa la variable de entorno `OCTO_ENGINE_API_KEY`.
    <Warning>No publiques claves de API en Git, scripts, documentación, capturas, registros compartidos ni salidas de CI.</Warning>
  </Step>

  <Step title="Crear o buscar una tarea">
    Usa `octoparse detect <url>` para generar un archivo desde una URL, crea una tarea desde una plantilla o usa `octoparse task list` para encontrar un ID existente.
  </Step>

  <Step title="Ejecutar o controlar la tarea">
    Ejecútala localmente, inicia o detén una ejecución en la nube, configura una programación o consulta su estado.
  </Step>

  <Step title="Inspeccionar y exportar datos">
    Comprueba el estado, previsualiza filas, revisa los datos no exportados o exporta resultados locales o en la nube.
  </Step>
</Steps>

## Ejemplos rápidos de comandos

Sustituye `<taskId>` por el ID real de la tarea y `<url>` por la página que quieras extraer.

```bash theme={null}
octoparse --help
octoparse doctor
octoparse auth login
octoparse detect <url> --auto --goal "Extract product titles and prices" --output task.json
octoparse task list
octoparse task inspect <taskId>
octoparse capabilities --json
octoparse run <taskId>
octoparse cloud start <taskId>
octoparse local status <taskId>
octoparse data export <taskId> --source local --format xlsx
```

## Limitaciones actuales

Octoparse CLI v1 no admite kernel browser ni flujos heredados.

Kernel browser designa el modo utilizado por entornos de ejecución antiguos de Octoparse. Los flujos heredados son tareas creadas con definiciones antiguas que el entorno actual de la CLI no admite.

Si una tarea no es compatible, reconstrúyela o actualízala en la aplicación de escritorio actual y vuelve a ejecutarla con la CLI.

## Siguientes pasos

<CardGroup cols={3}>
  <Card title="Instalar Octoparse CLI" icon="download" href="./cli/quick-start/installation">Configura Node.js, instala la CLI con npm y verifica el entorno local.</Card>
  <Card title="Crear tareas desde una URL" icon="wand-magic-sparkles" href="./cli/guides/detect">Usa detect para generar un archivo de tarea desde cualquier URL.</Card>
  <Card title="Consultar todos los comandos" icon="list-check" href="./cli/reference/command-cheatsheet">Revisa los comandos de tareas, plantillas, programaciones, detect, ejecuciones locales y en la nube, autenticación y exportación.</Card>
</CardGroup>