> For the complete documentation index, see [llms.txt](https://docs.mindee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mindee.com/v2/fr/integrations/client-libraries-sdk/command-line-tools-cli.md).

# Outils en ligne de commande (CLI)

Toutes nos API sont asynchrones ; par conséquent, il n'est pas très pratique d'utiliser cURL ou l'équivalent pour des tests rapides.

Pour cette raison, les SDK incluent une interface en ligne de commande (CLI) afin de permettre des tests rapides et le débogage de vos modèles.

{% tabs %}
{% tab title="Python" %}

```bash
# Installer la bibliothèque
pip install mindee

# Aide générale
mindee --help

# Aide pour les Modèles Extraction
mindee extraction --help

# Exécuter l'extraction sur un fichier
#   -k : clé API, vous pouvez à la place `export MINDEE_V2_API_KEY=md_XXXXXXXXXXXX`
#   -m : votre ID de modèle
#   Argument positionnel : chemin absolu vers le fichier
mindee extraction \\
  -k md_XXXXXXXXXXXX \\
  -m xxxx-xxxx-xxxx-xxxx-xxxx \\
  /path/to/the/file.pdf
```

{% endtab %}

{% tab title="Node.js" %}

```shellscript
# Installer la bibliothèque
npm install mindee

# Aide générale
./node_modules/.bin/mindeeV2 --help

# Aide pour les Modèles Extraction
./node_modules/.bin/mindeeV2 extraction --help

# Exécuter l'extraction sur un fichier
#   -k : clé API, vous pouvez à la place `export MINDEE_V2_API_KEY=md_XXXXXXXXXXXX`
#   -m : votre ID de modèle
#   Argument positionnel : chemin absolu vers le fichier
./node_modules/.bin/mindeeV2 extraction \\
  -k md_XXXXXXXXXXXX \\
  -m xxxx-xxxx-xxxx-xxxx-xxxx \\
  /path/to/the/file.pdf
```

{% endtab %}

{% tab title="Ruby" %}

```bash
# Aide générale
./bin/mindee.rb --help

# Aide pour les Modèles Extraction
./bin/mindee.rb extraction --help

# Exécuter l'extraction sur un fichier
#   -k : clé API, vous pouvez à la place `export MINDEE_V2_API_KEY=md_XXXXXXXXXXXX`
#   -m : votre ID de modèle
#   Argument positionnel : chemin absolu vers le fichier
./bin/mindee.rb extraction \\
  -k md_XXXXXXXXXXXX \\
  -m xxxx-xxxx-xxxx-xxxx-xxxx \\
  /path/to/the/file.pdf
```

{% endtab %}

{% tab title="PHP" %}

```bash
# Aide générale
php ./bin/cli.php --help

# Aide pour les Modèles Extraction
php ./bin/cli.php extraction --help

# Exécuter l'extraction sur un fichier
#   -k : clé API, vous pouvez à la place `export MINDEE_V2_API_KEY=md_XXXXXXXXXXXX`
#   -m : votre ID de modèle
#   Argument positionnel : chemin absolu vers le fichier
php ./bin/cli.php extraction \\
  -k md_XXXXXXXXXXXX \\
  -m xxxx-xxxx-xxxx-xxxx-xxxx \\
  /path/to/the/file.pdf
```

{% endtab %}

{% tab title="Java" %}
À utiliser depuis la racine du [dépôt Git](https://github.com/mindee/mindee-api-java).

```bash
# Compiler localement
mvn clean verify

# Aide générale
./cli.sh --help

# Aide pour les Modèles Extraction
./cli.sh extraction --help

# Exécuter l'extraction sur un fichier
#   -k : clé API, vous pouvez à la place `export MINDEE_V2_API_KEY=md_XXXXXXXXXXXX`
#   -m : votre ID de modèle
#   Argument positionnel : chemin absolu vers le fichier
./cli.sh extraction \\
  -k md_XXXXXXXXXXXX \\
  -m xxxx-xxxx-xxxx-xxxx-xxxx \\
  /path/to/the/file.pdf
```

{% endtab %}

{% tab title=".NET" %}
Installez d'abord le package CLI : <https://www.nuget.org/packages/Mindee.Cli>

Remarque : il s'agit d'un package distinct du SDK Mindee général.

```bash
# Installer le package
dotnet tool install Mindee.Cli

# Aide générale
dotnet mindee --help

# Aide pour les Modèles Extraction
dotnet mindee extraction --help

# Exécuter l'extraction sur un fichier
#   -k : clé API, vous pouvez à la place `export MINDEE_V2_API_KEY=md_XXXXXXXXXXXX`
#   -m : votre ID de modèle
#   Argument positionnel : chemin absolu vers le fichier
dotnet mindee extraction \\
  -k md_XXXXXXXXXXXX \\
  -m xxxx-xxxx-xxxx-xxxx-xxxx \\
  /path/to/the/file.pdf
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
Nous travaillons encore d'arrache-pied pour rendre les utilitaires CLI plus complets et utiles.\
**Par conséquent, l'interface n'est pas encore considérée comme stable et peut être modifiée.**

Si vous avez des idées pour les améliorer, [faites une demande de fonctionnalité !](https://feedback.mindee.com/?b=682f69c9e2404756e7e68d1c)
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.mindee.com/v2/fr/integrations/client-libraries-sdk/command-line-tools-cli.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.