DEV Community

Cover image for Comment utiliser Apidog CLI dans Cline
Antoine Laurent
Antoine Laurent

Posted on • Originally published at apidog.com

Comment utiliser Apidog CLI dans Cline

Cline fonctionne en boucle : il planifie une modification, édite des fichiers, exécute des commandes, lit leur sortie, puis choisit l’étape suivante. Si vos tests d’API restent dans une interface graphique Apidog, votre agent ne les exécute jamais. Intégrez la CLI Apidog à ses règles de projet pour que les tests API fassent partie de la même boucle que les tests unitaires.

Essayez Apidog dès aujourd’hui

La solution repose sur apidog-cli, le package npm qui exécute depuis le terminal les scénarios de test créés dans Apidog. Une fois la CLI installée et déclarée dans les règles Cline, l’agent peut lancer un scénario, analyser le code de sortie et corriger le code si le test échoue.

Avant de continuer, vérifiez que la CLI est installée, que votre compte est authentifié et que cette commande renvoie une version :

apidog --version
Enter fullscreen mode Exit fullscreen mode

Pour l’installation npm, l’authentification et le premier lancement avec un agent, consultez Comment installer la CLI Apidog avec un agent de codage IA.

De quelle Cline parle-t-on ?

Cline est un agent de codage open source disponible comme extension VS Code, avec également des versions JetBrains et CLI. Il lit le dépôt, planifie une tâche en mode Plan, puis passe en mode Action pour modifier des fichiers et exécuter des commandes shell.

Cline charge les règles du projet au début d’une tâche. C’est ce mécanisme qui permet de remplacer une instruction ponctuelle du type « exécute mes tests » par une règle durable, versionnée avec votre code.

Pour installer Cline et choisir un modèle, consultez Comment utiliser Cline.

Étape 1 : Ajoutez une règle Apidog dans .clinerules/

Cline charge les fichiers .md et .txt présents dans le répertoire .clinerules/ à la racine de l’espace de travail. Vous pouvez aussi utiliser un fichier unique .clinerules, mais un dossier est plus facile à maintenir lorsque les règles se multiplient.

La documentation officielle décrit ce fonctionnement dans la référence des règles Cline.

Créez le fichier suivant à la racine du dépôt :

.clinerules/apidog.md
Enter fullscreen mode Exit fullscreen mode

Ajoutez une règle explicite :

# Tests API avec Apidog

- Pour tester l'API, exécutez la CLI Apidog, et non curl ou des scripts ad hoc.
- Commande : apidog run -t <scenario_id> -e <env_id> -r cli
- L'ID du scénario et l'ID de l'environnement proviennent de l'onglet CI/CD d'Apidog. Utilisez ces valeurs exactes.
- Le code de sortie 0 signifie que toutes les assertions ont réussi. Un code non nul signifie un échec.
- Le code de sortie est la source de vérité, pas le résumé produit par l'agent.
- La machine est déjà authentifiée via `apidog login`. N'ajoutez jamais `--access-token` et ne stockez jamais de jeton dans ce fichier.
- Si un drapeau est inconnu, exécutez `apidog run --help` et utilisez le drapeau affiché par votre version installée.
Enter fullscreen mode Exit fullscreen mode

Cette règle est préférable à un rappel dans le chat :

  • elle est chargée pour chaque nouvelle tâche ;
  • elle est disponible pour tous les contributeurs du dépôt ;
  • elle est versionnée avec le code ;
  • elle évite que Cline invente une commande ou oublie les identifiants du scénario.

Étape 2 : Copiez la commande générée par Apidog

N’écrivez pas une commande apidog run de mémoire. Ouvrez votre scénario dans Apidog, accédez à l’onglet CI/CD, puis copiez la commande générée.

Exemple :

apidog run -t 8291 -e 42 -r cli
Enter fullscreen mode Exit fullscreen mode

Dans cette commande :

  • -t 8291 est l’ID du scénario de test ;
  • -e 42 est l’ID de l’environnement ;
  • -r cli active le rapport directement dans le terminal.

Copiez ces valeurs exactes dans .clinerules/apidog.md. Ainsi, Cline utilise toujours le bon scénario et le bon environnement.

Pour les options disponibles, consultez la référence de la commande apidog run.

Étape 3 : Demandez à Cline d’exécuter le scénario

Après avoir ajouté la règle, démarrez une nouvelle tâche dans Cline. Il chargera automatiquement .clinerules/.

Vous pouvez lui demander simplement :

Exécutez le scénario de test Apidog et indiquez-moi le résultat.
Enter fullscreen mode Exit fullscreen mode

Ou l’intégrer à une tâche de modification API :

Modifiez le gestionnaire de paiement, puis exécutez le scénario de test Apidog. Corrigez les erreurs si les assertions échouent.
Enter fullscreen mode Exit fullscreen mode

Cline doit alors :

  1. lire la règle .clinerules/apidog.md ;
  2. exécuter apidog run avec les bons IDs ;
  3. lire la sortie du terminal ;
  4. utiliser le code de sortie pour déterminer si le test a réussi ;
  5. corriger le code et relancer le test si nécessaire.

Selon vos paramètres d’approbation, Cline peut demander une validation avant d’exécuter la commande. Si vous autorisez l’exécution automatique des commandes sûres, un scénario de test en lecture seule contre un environnement de staging peut être exécuté sans intervention.

Étape 4 : Lisez le rapport dans Cline

Avec -r cli, Apidog affiche un rapport détaillé dans le terminal. Cline peut y lire :

  • les requêtes exécutées ;
  • les assertions vérifiées ;
  • l’assertion en échec ;
  • la valeur attendue et la valeur reçue ;
  • le code de sortie final.

Lorsqu’un test échoue, utilisez le détail de l’assertion pour orienter la correction. Par exemple, une sortie peut indiquer :

  • un code HTTP inattendu ;
  • un champ absent ;
  • une valeur de réponse incorrecte ;
  • une structure JSON non conforme.

Pour conserver aussi un rapport consultable dans un navigateur, ajoutez le rapporteur HTML :

apidog run -t 8291 -e 42 -r cli,html
Enter fullscreen mode Exit fullscreen mode

Le rapporteur html génère un fichier dans ./apidog-reports. Conservez cli afin que Cline dispose toujours de la sortie texte nécessaire pour analyser l’exécution.

Pour les rapporteurs HTML et JUnit, consultez le guide complet de la CLI Apidog et le guide des rapports de test de la CLI Apidog.

Intégrez le test API à la boucle de Cline

L’objectif n’est pas uniquement de demander à Cline d’exécuter un test une fois. La règle doit lui permettre d’inclure le scénario dans son cycle normal :

modifier → tester → lire le résultat → corriger → retester
Enter fullscreen mode Exit fullscreen mode

Par exemple, si Cline modifie un gestionnaire qui construit une réponse de paiement :

  1. il édite le gestionnaire ;
  2. il exécute le scénario Apidog contre l’environnement de staging ;
  3. il lit le code de sortie ;
  4. si le résultat est 0, il poursuit la tâche ;
  5. si le résultat est non nul, il examine l’assertion défaillante ;
  6. il corrige le code ;
  7. il relance le scénario.

Le test API devient alors un contrôle automatisé au même niveau que vos tests unitaires.

Pour aller plus loin sur ce modèle, consultez comment utiliser les agents IA pour les tests d’API et le harnais de test IA d’Apidog.

Vérifiez que Cline exécute réellement la CLI

Un agent peut résumer une action sans l’avoir réellement exécutée. Vérifiez systématiquement ces trois points.

1. La commande apparaît dans la sortie

Dans la vue de tâche Cline, recherchez la commande exécutée :

apidog run ...
Enter fullscreen mode Exit fullscreen mode

Vous devez voir la commande littérale, suivie de sa sortie. Si Cline affirme avoir exécuté le test mais qu’aucune commande n’est visible, demandez-lui de relancer le scénario et d’afficher la sortie brute.

2. Vérifiez le code de sortie

Posez explicitement la question :

Quel était le code de sortie de cette commande apidog run ?
Enter fullscreen mode Exit fullscreen mode

La règle est simple :

  • 0 : toutes les assertions ont réussi ;
  • code non nul : au moins une assertion a échoué.

Si le résumé de Cline indique « tests réussis » alors que le code de sortie est non nul, fiez-vous au code de sortie.

3. Vérifiez les IDs du scénario et de l’environnement

Une erreur du type « scénario introuvable » indique souvent un ID inventé ou incorrect.

Comparez alors :

  • les valeurs -t et -e du fichier .clinerules/apidog.md ;
  • la commande générée dans l’onglet CI/CD du scénario Apidog.

Les IDs provenant d’Apidog font autorité.

Optionnel : connectez le serveur MCP d’Apidog

La CLI couvre l’exécution des scénarios. Le serveur MCP complète cette approche en donnant à Cline accès à la spécification d’API pendant qu’il écrit le code.

Dans l’extension VS Code :

  1. ouvrez le panneau Cline ;
  2. cliquez sur l’icône Serveurs MCP ;
  3. ouvrez Configurer ;
  4. éditez cline_mcp_settings.json ;
  5. ajoutez le serveur sous mcpServers.

Vous pouvez aussi installer des serveurs depuis le Marketplace MCP, comme expliqué dans la documentation MCP de Cline.

Le serveur MCP Apidog expose vos spécifications d’API via MCP :

  • la CLI exécute les tests ;
  • MCP fournit le schéma et le contexte API à l’agent.

Cline reste une extension interactive. Pour lancer apidog run dans un pipeline CI/CD sans Cline, consultez la CLI Apidog dans GitHub Actions et le guide de pipeline CI/CD de la CLI Apidog.

Dépannage

Cline ignore le fichier de règles

Vérifiez les points suivants :

  • le dossier s’appelle exactement .clinerules ;
  • il est placé à la racine de l’espace de travail ;
  • le fichier se termine par .md ou .txt ;
  • vous démarrez une nouvelle tâche après la modification.

Une nouvelle tâche force Cline à recharger les règles.

Cline ajoute --access-token

Si Cline tente d’ajouter un jeton d’accès, renforcez la règle suivante :

La machine est déjà authentifiée via `apidog login`. N'ajoutez jamais `--access-token`.
Enter fullscreen mode Exit fullscreen mode

Ne stockez jamais un vrai jeton dans .clinerules/. Pour comprendre l’authentification de la CLI, consultez le guide d’authentification de la CLI Apidog.

Cline invente un drapeau

Une erreur telle que « option inconnue » signifie que l’agent a utilisé une option qui n’existe pas dans votre version de la CLI.

Demandez-lui d’exécuter :

apidog run --help
Enter fullscreen mode Exit fullscreen mode

Puis de réutiliser exactement les drapeaux affichés.

Cline signale un succès malgré un échec

Traitez le code de sortie comme l’unique source de vérité :

0       → succès
non nul → échec
Enter fullscreen mode Exit fullscreen mode

Cette règle doit apparaître dans .clinerules/apidog.md et dans vos procédures de vérification.

Passez d’un agent quotidien à une boucle testée

La configuration tient en trois étapes :

  1. installez apidog-cli avec le guide d’installation ;
  2. copiez la commande apidog run générée par votre scénario ;
  3. ajoutez-la à .clinerules/apidog.md.

Cline peut alors exécuter vos tests API pendant qu’il travaille sur une modification, au lieu d’attendre une validation manuelle après coup.

Vous continuez à construire visuellement vos scénarios dans Apidog, tandis que Cline les exécute dans sa boucle de développement. Téléchargez Apidog, créez un scénario, ajoutez sa commande dans .clinerules/apidog.md, puis laissez Cline l’utiliser à la prochaine modification API.

Top comments (0)