Comment utiliser Apidog CLI dans OpenClaw

OpenClaw fonctionne en boucle : il lit votre espace de travail, exécute des commandes shell, analyse leur sortie, puis décide de l’action suivante. Si vos tests API restent dans une interface graphique, l’agent ne les exécute pas. Avec la CLI Apidog, vous pouvez intégrer ces tests à la même boucle que vos tests unitaires : exécuter, vérifier le code de sortie, corriger si nécessaire.

Essayez Apidog dès aujourd’hui

La CLI d’Apidog est le package npm apidog-cli. Elle exécute depuis le terminal les scénarios créés dans Apidog. Une fois la CLI installée et référencée dans les instructions d’OpenClaw, l’agent peut lancer apidog run, lire le résultat et traiter un échec comme un blocage de validation.

Ce guide montre comment :

1. enregistrer les règles Apidog dans AGENTS.md ;
2. récupérer la commande exacte du scénario ;
3. autoriser OpenClaw à exécuter apidog run ;
4. interpréter les rapports et les codes de sortie.

Avant de continuer, vérifiez que la CLI est installée et authentifiée :

apidog --version

Si nécessaire, consultez le guide d’installation de la CLI Apidog avec un agent de codage IA.

De quel OpenClaw s’agit-il ?

OpenClaw est un agent IA open source, local-first, exécuté sur votre machine. Il possède un espace de travail, des compétences et un outil d’exécution capable de lancer de vraies commandes shell.

Si vous utilisez openclaw localement pour modifier des fichiers et exécuter des commandes, ce guide vous concerne. Pour préparer votre environnement, consultez :

• l’automatisation du flux de travail de développement OpenClaw ;
• le guide d’installation sécurisée d’OpenClaw.

Le point important : OpenClaw lit les règles présentes dans votre espace de travail. Le fichier à utiliser est AGENTS.md.

Étape 1 : Ajoutez les règles Apidog à AGENTS.md

OpenClaw charge AGENTS.md comme un ensemble d’instructions persistantes. Contrairement à une instruction donnée dans une conversation, ce fichier reste disponible pour les futures sessions et pour les autres membres de l’équipe.

L’espace de travail par défaut est ~/.openclaw/workspace, mais vous pouvez cibler un projet via agents.list[].workspace. OpenClaw prend aussi en charge les fichiers AGENTS.md par sous-répertoire. Consultez la référence AGENTS.md d’OpenClaw.

Ajoutez ce bloc dans le fichier AGENTS.md du projet :

## Test d'API avec Apidog

- Pour exécuter les tests API, utilisez la CLI Apidog : `apidog run -t <scenario_id> -e <env_id> -r cli`.
- Un code de sortie 0 signifie que toutes les assertions ont réussi. Un code non nul signifie qu'un élément a échoué. Traitez-le comme la porte de réussite/échec.
- La machine est déjà authentifiée avec `apidog login`. N'ajoutez jamais d'option --access-token et ne placez jamais de jeton dans ce fichier.
- Si un indicateur semble inconnu, exécutez `apidog run --help` au lieu de deviner.

Remplacez ensuite <scenario_id> et <env_id> par les identifiants réels de votre scénario.

Ne stockez jamais de jeton d’accès dans AGENTS.md. Utilisez l’authentification locale effectuée avec apidog login.

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

Ne saisissez pas les ID manuellement.

1. Ouvrez votre scénario de test dans Apidog.
2. Accédez à l’onglet CI/CD.
3. Copiez la commande générée.

Elle ressemble à ceci :

apidog run -t 1234567 -e 890123 -r cli

Les options principales sont :

Option	Rôle
-t	ID du scénario de test
-e	ID de l’environnement
-r cli	Affiche le rapport dans le terminal

Collez la commande avec les vrais ID dans AGENTS.md. Ainsi, OpenClaw exécute toujours le bon scénario contre le bon environnement.

Pour les options disponibles, consultez le guide complet de la CLI Apidog et la référence de apidog run.

Étape 3 : Autorisez OpenClaw à lancer le test

Démarrez OpenClaw dans votre projet, puis demandez-lui d’exécuter les tests API après une modification ou à la demande.

Grâce à AGENTS.md, l’agent sait qu’il doit appeler :

apidog run -t 1234567 -e 890123 -r cli

OpenClaw exécute les commandes via son outil d’exécution shell. Cet outil est contrôlé par un mode de permission :

• deny : bloque l’exécution ;
• allowlist : n’autorise que les commandes listées ;
• ask : demande une confirmation ;
• auto : exécute automatiquement les commandes autorisées et demande une validation pour les autres ;
• full : exécution complète.

Ces modes sont décrits dans la documentation OpenClaw sur les permissions.

Pour un agent de développement, utilisez généralement auto sous tools.exec dans openclaw.json :

• les commandes autorisées s’exécutent sans interruption ;
• les autres commandes restent soumises à validation ;
• apidog run peut être ajouté à la liste blanche si vous voulez lancer automatiquement les tests sur un environnement de staging.

Si vous utilisez le mode ask, OpenClaw demandera votre approbation avant chaque exécution de apidog run.

Étape 4 : Lisez le rapport et le code de sortie

Le rapporteur cli affiche dans le terminal :

• les requêtes exécutées ;
• les assertions ;
• les valeurs attendues et réelles ;
• l’assertion précise qui a échoué.

C’est cette sortie qu’OpenClaw lit pour décider s’il doit poursuivre ou corriger le code.

La règle est simple :

Code de sortie 0      → toutes les assertions ont réussi
Code de sortie non nul → au moins une assertion a échoué

Gardez donc -r cli dans la commande.

Générer aussi un rapport HTML

Pour partager un rapport ou l’ouvrir dans un navigateur, ajoutez le rapporteur HTML :

apidog run -t 1234567 -e 890123 -r cli,html

Le rapporteur html génère un fichier autonome dans ./apidog-reports.

Conservez cli en parallèle : OpenClaw a besoin de la sortie texte pour interpréter l’exécution immédiatement. Pour JUnit et les autres formats, consultez le guide des rapports de test de la CLI Apidog.

Intégrer les tests API à la boucle d’OpenClaw

Une fois la règle enregistrée, OpenClaw peut appliquer ce flux après une modification d’API :

1. modifier un gestionnaire ou un endpoint ;
2. exécuter le scénario Apidog ;
3. lire le code de sortie ;
4. analyser l’assertion en échec ;
5. corriger le code ;
6. relancer le scénario.

Par exemple, si OpenClaw modifie un gestionnaire de réponse de paiement, le scénario peut signaler :

• un mauvais code de statut ;
• un champ attendu absent ;
• une valeur de réponse incorrecte.

L’agent peut alors corriger la modification avant de considérer la tâche comme terminée.

Ce fonctionnement applique le modèle « déléguer puis vérifier » : OpenClaw exécute la commande et lit le résultat, tandis que vous continuez à concevoir et maintenir visuellement les scénarios dans Apidog.

Pour aller plus loin, consultez :

• comment utiliser les agents IA pour les tests API ;
• le harnais de test IA Apidog.

Vérifier qu’OpenClaw a réellement exécuté la CLI

Ne vous fiez pas uniquement au résumé de l’agent. Vérifiez ces trois points.

1. Confirmez la commande exécutée

Le transcript OpenClaw doit contenir une ligne similaire à :

apidog run -t 1234567 -e 890123 -r cli

Il doit aussi montrer la sortie produite par la commande.

Si OpenClaw affirme avoir exécuté les tests mais qu’aucune commande n’apparaît dans le transcript, demandez-lui de relancer le test et d’afficher la sortie brute.

2. Demandez le code de sortie

Posez explicitement cette question :

Quel était le code de sortie de cette commande apidog run ?

Un résumé indiquant « tests réussis » ne suffit pas. Si le code de sortie est non nul, l’exécution doit être considérée comme un échec.

3. Vérifiez les ID de scénario et d’environnement

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

Comparez les valeurs suivantes :

-t <scenario_id>
-e <env_id>

avec :

1. la commande générée dans l’onglet CI/CD d’Apidog ;
2. la commande stockée dans AGENTS.md.

Les valeurs présentes dans AGENTS.md doivent rester votre source de vérité opérationnelle.

Facultatif : connectez le serveur MCP Apidog

La CLI couvre l’exécution des tests. Vous pouvez aussi connecter Apidog à OpenClaw via le Model Context Protocol (MCP).

OpenClaw prend en charge les serveurs MCP avec :

openclaw mcp add <name>

Cette commande enregistre la définition du serveur dans ~/.openclaw/openclaw.json, sous mcp.servers. Elle accepte notamment les options stdio --command et --arg. Consultez la documentation MCP d’OpenClaw.

Le serveur MCP Apidog permet à OpenClaw de lire vos spécifications API pendant qu’il écrit le code.

La répartition est alors claire :

• CLI Apidog : exécuter les scénarios de test ;
• MCP Apidog : fournir la spécification API à l’agent.

Dépannage

OpenClaw ignore AGENTS.md

Vérifiez que le fichier se trouve dans l’espace de travail actif de l’agent.

OpenClaw peut charger des fichiers AGENTS.md par sous-répertoire. Une règle placée dans un mauvais sous-arbre peut donc ne pas être appliquée. Redémarrez la session afin de forcer une nouvelle lecture des instructions.

OpenClaw n’exécute aucune commande

Vérifiez la configuration tools.exec dans openclaw.json.

Si l’exécution est refusée ou bloquée par une liste blanche, passez au mode auto ou ajoutez apidog à la liste blanche. Le guide d’installation sécurisée d’OpenClaw explique comment autoriser une commande sans ouvrir toutes les permissions.

OpenClaw ajoute --access-token

Ne mettez pas de jeton dans les instructions. Votre bloc AGENTS.md doit indiquer explicitement que l’authentification est déjà réalisée avec :

apidog login

Pour la configuration correcte, consultez la documentation sur l’authentification de la CLI Apidog.

OpenClaw invente une option

Si apidog run retourne une erreur unknown option, ne corrigez pas au hasard. Exécutez :

apidog run --help

Utilisez ensuite uniquement les options affichées par la version installée.

OpenClaw annonce un succès malgré un échec

Le code de sortie prévaut toujours sur le résumé de l’agent.

Si la commande retourne une valeur non nulle, traitez le test comme échoué, même si OpenClaw affirme le contraire. Le même principe s’applique avec d’autres agents, comme expliqué dans la CLI Apidog dans Codex et dans la comparaison Claude Code vs OpenClaw.

Résumé

Pour intégrer les tests API à OpenClaw :

1. installez apidog-cli ;
2. authentifiez la machine avec apidog login ;
3. copiez la commande CI/CD du scénario Apidog ;
4. ajoutez cette commande et les règles de code de sortie dans AGENTS.md ;
5. configurez tools.exec pour autoriser apidog run ;
6. utilisez le code de sortie comme critère de réussite ou d’échec.

Vos scénarios restent créés visuellement dans Apidog, mais OpenClaw peut désormais les exécuter pendant qu’il travaille sur le code.

Téléchargez Apidog, créez un scénario, ajoutez sa commande apidog run dans AGENTS.md, puis laissez OpenClaw l’intégrer à sa prochaine boucle de modification. Pour appliquer le même contrôle dans un pipeline CI, consultez la CLI Apidog dans GitHub Actions.