Skip to main content
Usa salidas legibles por máquinas y la detección de funciones en lugar de analizar la ayuda destinada a personas en scripts o Flujos de trabajo de agentes.

Descubrir el contrato actual

La respuesta describe los comandos compatibles, la autenticación, los modos de navegador, los esquemas de salida, los eventos del ciclo de vida y las recetas recomendadas para agentes. Los agentes deben inspeccionar el contrato al iniciar un Flujo de trabajo, en vez de codificar suposiciones sobre opciones o campos JSON.

Autenticarse en CI

El orden de prioridad de las credenciales es: token de acceso, clave de API y credenciales almacenadas mediante octoparse auth login.
No imprimas, confirmes ni incluyas credenciales en registros compartidos, capturas de pantalla o documentación generada.

Elegir un modo de salida

  • --json devuelve un único contenedor de resultados.
  • --jsonl transmite los eventos de una ejecución en primer plano como JSON Lines.
  • La salida para personas está destinada al uso interactivo en la terminal.
Consulta Salida y códigos de salida para conocer los esquemas, eventos del ciclo de vida, comportamiento de stdout/stderr y códigos de error.

Crear tareas con un agente

Los agentes deben usar detect --agent o el Flujo de trabajo de preparación, vista previa y aplicación, no --auto.
Sigue machineContract.recipes.createTaskFromUrlWithAgent en la respuesta de funciones. Proporciona a --agent-command únicamente un ejecutable de confianza.

Confirmar comandos que modifican el estado

Los comandos que renombran, mueven, eliminan, actualizan o cambian programaciones pueden requerir --yes. Usa capabilities --json para conocer los requisitos de confirmación antes de crear la automatización.

Comandos internos

env cambia los entornos internos de la API y runs inspecciona artefactos locales internos. No forman parte del Flujo de trabajo principal. Es preferible usar comandos públicos con identificadores de Tarea y lote, salvo que el soporte de Octoparse indique lo contrario.