> ## 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

> Utilisez Octoparse CLI pour créer, exécuter, gérer, planifier, inspecter, automatiser et exporter des tâches en local ou dans le Cloud.

Octoparse CLI est un outil en ligne de commande permettant de créer, exécuter, gérer, planifier, inspecter et exporter des tâches Octoparse depuis un terminal.

Contrairement à l’application de bureau, Octoparse CLI est conçu pour les Flux de travail scriptés, les pipelines CI/CD, les environnements serveur et les pipelines de données automatisés.

## Fonctionnalités d’Octoparse CLI

<CardGroup cols={2}>
  <Card title="Créer des tâches à partir d’une URL" icon="wand-magic-sparkles" href="./cli/guides/detect">
    Inspectez n’importe quelle URL et générez automatiquement ou manuellement un fichier de tâche local, ou faites-le au moyen du Flux de travail d’un agent IA.
  </Card>

  <Card title="Rechercher et gérer les tâches" icon="magnifying-glass" href="./cli/guides/tasks-and-groups">
    Répertoriez les tâches dans le Cloud, effectuez une recherche par mot-clé, inspectez les détails d’une tâche et utilisez les Groupes de tâches.
  </Card>

  <Card title="Créer à partir de modèles" icon="table-cells" href="./cli/guides/templates">
    Affichez et recherchez des modèles, créez des Modèles de tâche et modifiez-les.
  </Card>

  <Card title="Exécuter les tâches en local" icon="play" href="./cli/guides/local-runs">
    Exécutez des tâches Octoparse avec le moteur local intégré et une instance Chrome indépendante.
  </Card>

  <Card title="Choisir un mode de navigateur" icon="window" href="./cli/guides/browser-modes">
    Utilisez une instance Chrome indépendante ou réutilisez un profil Chrome ou Edge déjà connecté.
  </Card>

  <Card title="Exécuter et planifier des tâches dans le Cloud" icon="calendar" href="./cli/guides/cloud-runs-and-schedules">
    Démarrez une Extraction dans le cloud, consultez l’historique et configurez des planifications récurrentes.
  </Card>

  <Card title="Inspecter et exporter les données" icon="file-export" href="./cli/guides/data">
    Vérifiez le nombre d’enregistrements, prévisualisez les lignes, consultez les données non exportées et exportez les résultats locaux ou dans le Cloud.
  </Card>

  <Card title="Automatiser avec des agents" icon="robot" href="./cli/guides/automation">
    Utilisez la sortie JSON, les flux d’événements JSONL et les codes de sortie pour intégrer la CLI aux scripts et agents IA.
  </Card>
</CardGroup>

## Fonctionnement

Octoparse CLI exécute directement le moteur Octoparse intégré pour l’Extraction locale. Il utilise une instance Chrome indépendante et ne nécessite pas le client de bureau Electron.

L’Extraction dans le cloud est contrôlée par les API du service. L’Extraction locale est contrôlée par le moteur local.

<Note>
  L’état des exécutions locales est suivi par cette CLI et n’est pas synchronisé avec celui du client de bureau Octoparse.
</Note>

## Configuration requise

Avant d’utiliser Octoparse CLI, assurez-vous de disposer des éléments suivants :

* Node.js 20 ou version ultérieure
* npm 8 ou version ultérieure
* Un compte Octoparse (clé API ou OAuth)
* Un accès aux tâches que vous souhaitez exécuter ou exporter

Consultez la page [Installation](./cli/quick-start/installation) pour connaître la configuration requise selon la plateforme et les étapes d’installation, notamment les limitations de Linux arm64.

Les commandes fonctionnelles nécessitent une authentification, y compris les exécutions locales avec `--task-file` et les fichiers `.otd`. Les commandes de configuration et de diagnostic telles que `--help`, `--version`, `doctor`, `browser`, `capabilities` et `auth` peuvent être exécutées sans authentification.

## Flux de travail courant

<Steps>
  <Step title="Installer Octoparse CLI">
    Installez globalement la CLI avec npm.
  </Step>

  <Step title="S’authentifier">
    Connectez-vous avec OAuth ou une clé API Octoparse. Pour la CI, utilisez la variable d’environnement `OCTO_ENGINE_API_KEY`.

    <Warning>
      Ne publiez jamais de clés API dans Git, des scripts, la documentation, des captures d’écran, des journaux partagés ou la sortie de la CI.
    </Warning>
  </Step>

  <Step title="Créer ou rechercher une tâche">
    Utilisez `octoparse detect <url>` pour générer un fichier de tâche à partir d’une URL, créez une tâche depuis un modèle ou utilisez `octoparse task list` pour trouver l’ID d’une tâche existante.
  </Step>

  <Step title="Exécuter ou contrôler la tâche">
    Exécutez la tâche en local, démarrez ou arrêtez une exécution dans le Cloud, configurez une planification dans le Cloud ou vérifiez l’état de l’exécution.
  </Step>

  <Step title="Inspecter et exporter les données">
    Vérifiez l’état des données, prévisualisez les lignes, consultez les données non exportées ou exportez les données collectées depuis les résultats locaux ou dans le Cloud.
  </Step>
</Steps>

## Exemples de commandes courantes

Remplacez `<taskId>` par l’ID réel de votre tâche et `<url>` par la page à scraper.

```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
```

## Limitations actuelles

Octoparse CLI v1 ne prend pas en charge le navigateur du noyau ni les anciens Flux de travail.

Le navigateur du noyau désigne le mode de navigateur utilisé par les anciens Flux de travail d’exécution Octoparse. Un ancien Flux de travail désigne une tâche créée avec une ancienne définition de tâche Octoparse qui n’est pas prise en charge par l’environnement d’exécution actuel de la CLI.

Si une tâche n’est pas prise en charge, recréez-la ou mettez-la à jour dans la version actuelle de l’application de bureau Octoparse, puis exécutez-la de nouveau avec la CLI.

## Étapes suivantes

<CardGroup cols={3}>
  <Card title="Installer Octoparse CLI" icon="download" href="./cli/quick-start/installation">
    Configurez Node.js, installez la CLI avec npm et vérifiez l’environnement d’exécution local.
  </Card>

  <Card title="Créer des tâches à partir d’une URL" icon="wand-magic-sparkles" href="./cli/guides/detect">
    Utilisez `detect` pour générer un fichier de tâche à partir de n’importe quelle URL.
  </Card>

  <Card title="Parcourir toutes les commandes" icon="list-check" href="./cli/reference/command-cheatsheet">
    Consultez les commandes relatives aux tâches, modèles, planifications, à `detect`, aux exécutions locales et dans le Cloud, à l’authentification et à l’export.
  </Card>
</CardGroup>