Cette page est un guide d'utilisation rédigé pour un assistant AI : Claude Code, Codex, Cursor, ou tout autre assistant capable de lire une page web et, idéalement, de travailler sur une copie locale de votre dépôt. Il guide l'assistant dans la configuration de CoRoid pour un ou plusieurs dépôts. Il s'arrête à chaque étape qui nécessite une intervention humaine : connexion, attribution d'accès, saisie d'un secret ou approbation d'une modification.
Confiez-le à votre assistant
Ouvrez votre assistant dans le dépôt sur lequel vous souhaitez que CoRoid travaille, et donnez-lui ce prompt :
Set up CoRoid for this repository. Follow the runbook at
https://coroid.ai/docs/export/en-US/getting-started/assistant-setup.md
step by step. Ask me before you change anything, and never ask me to paste a
password or token into this chat.Pour plusieurs dépôts, ouvrez l'assistant dans un répertoire les contenant tous, et mentionnez-les dans l'instruction. L'assistant effectuera l'inspection et la vérification, et vous indiquera précisément ce qu'il faut faire à chaque étape nécessitant votre intervention.
Règles de base pour l'assistant
Vous configurez CoRoid, une plateforme de production logicielle hébergée de type AI. Une fois un projet configuré, toute personne au sein de l'entreprise peut décrire des tâches en langage courant, et CoRoid les compile, les teste et les examine selon les normes du projet avant d'ouvrir un pull request dans le dépôt concerné. Suivez ces règles tout au long du processus :
- L'utilisateur agit ; vous préparez. Vous ne pouvez pas vous inscrire, vous connecter, accepter les conditions, installer des applications ou accorder des accès pour l'utilisateur. Indiquez exactement ce qu'il doit faire et où, puis attendez que l'utilisateur confirme avoir terminé.
- Gardez les secrets hors de la conversation. Jamais de demande de mot de passe, de jeton d'accès personnel, de clé de fournisseur ou de jeton MCP. L'utilisateur saisit les secrets dans le portail CoRoid ou via son propre terminal. Si l'un d'eux est collé dans la discussion malgré tout, indiquez à l'utilisateur de le révoquer et d'en créer un nouveau.
- Demandez l'autorisation avant chaque modification: les commits, branches et demandes de fusion dans le dépôt de l'utilisateur, les projets CoRoid et les invitations.
- Vérifiez chaque étape avant de passer à la suivante. Si une vérification échoue, suivez les indications de cette étape, et continuez uniquement lorsqu'elle est validée ou si l'utilisateur décide de la sauter.
- Suivez le produit, pas vos suppositions. Si le portail affiche quelque chose que ce guide d'utilisation ne décrit pas, indiquez à l'utilisateur ce que vous voyez et suivez les indications du portail. Ne créez pas de paramètres fictifs.
- Conservez un historique de la configuration de chaque étape et de son résultat, pour la fin.
Chaque étape relie les pages avec leurs détails.
https://coroid.ai/llms.txt indexe l'ensemble de la documentation.
Étape 1 : Définir le plan
Posez à l'utilisateur ces questions ensemble, et non une par une :
| Question | Pourquoi c'est important |
|---|---|
| Sur quels dépôts CoRoid doit-il travailler ? | Un projet par dépôt. |
| GitHub ou GitLab ? Appartenant à une personne ou à une organisation ? | Détermine comment CoRoid se connecte et qui doit l'approuver. |
| CoRoid doit-il ouvrir des demandes de fusion (Synchronisé), ou conserver le travail à l'intérieur de CoRoid dans un premier temps (Local uniquement)? | Le mode Local uniquement n'écrit jamais dans le dépôt. |
| Existe-t-il déjà une organisation CoRoid, et sur quel forfait ? | Le forfait Gratuit permet un seul projet et aucun autre membre. |
| Qui d'autre va examiner le travail, et dans quel rôle ? | L'invitation de membres nécessite le forfait Professionnel. |
| CoRoid doit-il utiliser les clés de fournisseur de modèles propres à l'organisation ? | Optionnel. Les modèles routés par CoRoid n'en nécessitent pas. |
Ensuite, répétez le plan : les étapes ci-dessous qui requièrent l'intervention de l'utilisateur, ainsi que les dépôts concernés.
Voir Forfaits et tarifs, Limites et quotas et Synchronisé ou Local uniquement.
Étape 2 : Vérifier que chaque dépôt se compile et passe les tests à partir d'une copie propre.
C'est le travail le plus utile que vous puissiez effectuer. Chaque tâche CoRoid s'exécute dans un espace de travail Linux propre et temporaire : un clone frais, sans éléments en cache ni logiciels installés en dehors de l'outil fourni par l'image. Un agent incapable de compiler et de tester le projet ne peut pas valider son propre travail, et ses tâches échouent lors de la vérification pour des raisons sans rapport avec la modification apportée.
Si vous pouvez travailler localement dans le dépôt, faites ceci pour chacun d'eux :
- Identifiez les langages, le gestionnaire de paquets et si c'est un monorepo.
- Trouvez les commandes d'installation, de compilation et de test dans le README, la configuration CI et les manifestes.
- Demandez avant d'exécuter quoi que ce soit. Ensuite, clonez le dépôt dans un répertoire temporaire vide et exécutez y l'installation, la compilation et les tests sans aucune autre configuration. La copie de travail de l'utilisateur contient des caches et
.envdes fichiers qui masquent les problèmes. - Notez tout ce dont l'exécution avait besoin mais que la copie fraîche ne possède pas :
- Les services attendus par les tests, comme une base de données, un cache ou une file d'attente
- Les étapes précédant les tests, comme la génération de code, les migrations ou les jeux de données de test
- Des variables d'environnement ou un
.envfichier non commité - Des registres de paquets privés
- Un environnement d'exécution qui n'est pas présent dans le environnement de l'agent
Jamais exécutez de commandes qui déploient, publient ou interagissent avec des environnements partagés. Si le jeu de tests est lent ou utilise des services payants, demandez d'abord l'autorisation à l'utilisateur.
Signalez une brève vérification de prêt par dépôt : les commandes utilisées, la durée du jeu de tests, ce qui a réussi et chaque écart avec une solution proposée.
| Écart | Solution à proposer |
|---|---|
| Les tests nécessitent une base de données ou un autre service. | Un fichier Dockerfile ou Compose qui exécute le jeu de tests avec ses services associés. |
Un élément requis .env Le fichier n'est pas validé. | Les valeurs par défaut des tests sont définies dans le code, ou une configuration de test validée avec des valeurs non secrètes. |
| Un test nécessite un secret réel. | Simulez cette dépendance dans les tests. Jamais validez un secret. |
| Les dépendances proviennent d'un registre privé. | Informez l'utilisateur. CoRoid a besoin de ces identifiants pour la configuration du projet. |
| Les commandes ne fonctionnent qu'à partir d'un sous-répertoire. | Notez le répertoire exact et tout filtre d'espace de travail. |
L'absence d'un environnement d'exécution n'est pas non plus un blocage : un conteneur intégrant la chaîne d'outils résout ce problème. Si vous ne pouvez pas accéder au dépôt en local, collectez les informations disponibles auprès de l'utilisateur et indiquez que la vérification du clonage propre n'a pas eu lieu.
Consultez Configuration de build et de test et Prise en charge des langages et environnement des agents.
Étape 3 : Rédiger les instructions que les agents de CoRoid liront.
Avant chaque tâche, les agents de CoRoid lisent les fichiers de mémoire présents dans le dépôt :
AGENTS.md, CLAUDE.md ou GEMINI.md à la racine, ainsi que les règles de Cursor dans
.cursor/rules.
Les commandes que vous avez vérifiées à l'étape 2 doivent être placées là.
Proposez un AGENTS.md, ou une ajout à celui existant, indiquant :
- Les commandes d'installation, de build et de test, vérifiées depuis un clonage propre, ainsi que le répertoire où les exécuter.
- Les étapes et services requis pour les tests.
- Comment exécuter l'ensemble le plus restreint et utile de tests, comme un seul paquet ou un seul fichier.
- Les conventions et limites que le code ne montre pas : modules verrouillés, zones à ne pas modifier, dépendances à ne pas ajouter.
Omettez ce que le code indique déjà et gardez le fichier concis. Si CLAUDE.md
or .cursor/rules contient les mêmes instructions, conservez-les une seule fois dans AGENTS.md
et importez-le depuis l'autre fichier avec une ligne @AGENTS.md .
Si cela décrit un workflow Git local, consultez
AGENTS.md pour chaque agent.
Montrez la différence à l'utilisateur. Avec son approbation, validez-la sur une nouvelle branche et ouvrez un pull request, ou laissez-le le faire lui-même. Cette modification doit atteindre la branche de base avant la première tâche, car chaque tâche lit les fichiers de mémoire depuis son propre clonage de cette branche. Traitez les corrections de l'étape 2 acceptées par l'utilisateur de la même manière.
Consultez Paramètres du contexte du projet et Contexte du projet.
Étape 4 : Compte et organisation (l'utilisateur)
Ignorez cette étape si l'utilisateur appartient déjà à une organisation CoRoid en tant que Propriétaire ou Administrateur.
Demandez à l'utilisateur de :
- s'inscrire sur
https://client.coroid.ai/auth/signupavec son adresse e-mail professionnelle, et vérifier son adresse. - accepter les conditions d'utilisation
- créer l'organisation
Vérifier : l'utilisateur peut ouvrir https://client.coroid.ai/projects. La personne qui effectue cette configuration doit avoir le rôle de Propriétaire ou d'Administrateur, car seuls ces rôles peuvent connecter le contrôle de code source et ajouter les clés de fournisseur.
Consultez Créez votre compte et organisation.
Étape 5 : Connecter le contrôle de code source (l'utilisateur)
Examinez les exigences d'accès avec l'utilisateur avant qu'il ne commence. Une installation interrompue en cours pour obtenir l'approbation d'une autre personne est la raison habituelle pour laquelle cette étape prend un jour au lieu d'une minute.
GitHub
L'utilisateur ouvre Paramètres → Connexions → Contrôle de source
(https://client.coroid.ai/settings/connections/source-control).
| Option | Utiliser lorsque | Ce dont l'utilisateur a besoin sur GitHub |
|---|---|---|
| Application GitHub (recommandé) | Presque toujours | Autorisation pour installer des applications sur le compte ou l'organisation propriétaire des dépôts. Dans une organisation, il s'agit généralement du propriétaire ; les autres membres peuvent demander l'installation pour que le propriétaire l'approuve. |
| Jeton d'accès personnel | L'application nécessite une approbation que l'utilisateur ne peut pas obtenir. | Un jeton classique avec le repo champ, ou un jeton granulé avec lecture et écriture sur Contenu et Demandes de tirage pour les dépôts choisis. |
| Se connecter via URL, aucune connexion | Un dépôt public, testé dans Local uniquement | Rien |
Application GitHub : Sur l'écran d'installation de GitHub, l'utilisateur choisit Sélectionnez uniquement les dépôts et sélectionne celles convenues lors de l'étape 1. L'application continue de fonctionner même si la personne qui l'a installée quitte l'entreprise ; elle reçoit les événements de webhook et permet à CoRoid de publier ses vérifications sur les demandes de fusion. Un jeton ne peut pas publier de vérifications GitHub.
Jeton d'accès personnel : l'utilisateur le crée sur GitHub avec une date d'expiration, puis le colle dans le portail CoRoid. Privilégiez un jeton à portée restreinte limité aux dépôts convenus. Les demandes de fusion sont attribuées au propriétaire du jeton, et la connexion sera rompue si cette personne perd l'accès.
GitLab
GitLab est en version préliminaire privée et n'apparaît que sur les comptes où il est activé. Il se connecte via un jeton d'accès personnel avec la api portée. Si GitLab n'apparaît pas sous l'onglet Contrôle de source, indiquez à l'utilisateur de contacter CoRoid et ne planifiez rien autour de cela.
Protection de branche
CoRoid ouvre des demandes de fusion classiques, donc la protection des branches, les vérifications obligatoires et les règles de révision restent applicables. Il est recommandé de maintenir cette protection active. Si les règles exigent des commits signés ou une vérification d'état que CoRoid ne peut pas produire, ses demandes de fusion s'ouvriront mais resteront non fusionnables. Informez l'utilisateur et ne modifiez pas ses règles.
Vérification : le fournisseur apparaît comme connecté sous l'onglet Contrôle de source. La preuve concrète intervient à l'étape 6, lorsque les dépôts apparaissent dans la liste des projets.
Consultez Connectez votre code, GitHub, GitLab et Paramètres de dépôt et de branche.
Étape 6 : Créer les projets (l'utilisateur)
Créez un projet par dépôt ; jamais deux pour un même dépôt. L'utilisateur ouvre Projets → Nouveau (https://client.coroid.ai/projects/new) et, pour chaque dépôt :
- le sélectionne parmi le fournisseur connecté, ou utilise Se connecter via URL pour un dépôt public
- choisit le Mode de dépôt: Synchronisé, où CoRoid pousse les branches et ouvre des demandes de fusion, ou Local uniquement, où CoRoid n'écrit jamais dans le dépôt tant que quelqu'un ne choisit pas Démarrer la synchronisation
- vérifie la branche par défaut
- crée le projet
Si l'équipe fusionne dans une branche autre que la branche par défaut, comme
develop, définissez la branche de base dans les paramètres du dépôt du projet. Une mauvaise branche de base envoie les demandes de fusion vers une branche que personne ne révise.
Si un dépôt manque dans la liste, la cause est presque toujours l'une des suivantes :
- l'application GitHub n'a pas reçu l'autorisation pour ce dépôt
- la portée du jeton est trop restreinte pour l'énumérer
- le dépôt appartient à une organisation différente de celle connectée
Consultez Créez votre premier projet et Paramètres de dépôt et de branche.
Étape 7 : Vérifier ce que CoRoid a détecté.
Demandez à l'utilisateur d'ouvrir la vue d'ensemble de chaque projet et de lire les Dépôt détails et tout ce qui est listé sous Terminer la configuration:
- État et Branche: le dépôt est cloné, sur la branche de base que vous avez convenu. Si la vue d'ensemble indique que le dépôt n'a pas encore été cloné, l'utilisateur choisit Cloner le dépôt.
- Stack: les langages, frameworks, gestionnaires de paquets et outils de test que CoRoid a identifiés. Comparez-les avec votre contrôle de préparation. Si l'ensemble est vide ou incorrect après la première synchronisation, l'utilisateur peut le scanner à nouveau à partir de là.
- Terminer la configuration: des éléments tels que « Les dépendances n'ont pas été installées correctement » signalent les mêmes lacunes que lors de l'étape 2. Travaillez dessus avec l'utilisateur.
Ensuite, l'utilisateur ouvre les Paramètres → Connaissances → Contexte. Le fichier mémoire de l'étape 3 doit être listé sous Sources de dépôt et être activé. S'il affiche Créer à la place, le fichier n'a pas encore atteint la branche connectée.
Consultez Paramètres de contexte du projet et Configuration de build et de test.
Étape 8 : Paramètres de l'organisation (optionnel)
Demandez à l'utilisateur s'il souhaite configurer l'un de ces éléments maintenant. Tous ont des valeurs par défaut utilisables :
- Membres, sous Paramètres → Membres: les personnes qui réviseront les demandes de fusion, en tant que Propriétaire, Administrateur, Membre ou Réviseur. Il est recommandé de n'attribuer le rôle d'Administrateur qu'aux personnes pouvant modifier les politiques et les clés de fournisseur. Nécessite l'offre Professional.
- Clés de fournisseur, sous Paramètres → Clés de fournisseur: uniquement pour utiliser les comptes de fournisseurs de modèles propres à l'organisation. L'utilisateur saisit la clé dans le portail. Il est recommandé d'utiliser une clé restreinte avec une limite de dépense définie chez le fournisseur.
- Paramètres d'une autre organisation: exportez un lot de paramètres là-bas et
importez-le sous Paramètres → Données → Exporter les paramètres. Les secrets circulent sous forme
de place-holders, donc chaque
needsRebindélément dans l'aperçu nécessite une attention particulière.
Consultez Créez votre compte et votre organisation, Clés de fournisseur et Exporter et importer les paramètres.
Étape 9 : Se connecter soi-même à CoRoid (optionnel).
Si votre client prend en charge les serveurs MCP distants, vous pouvez accéder à CoRoid via son serveur MCP à l'adresse https://api.coroid.ai/mcp. La configuration ne dépend pas de cela, mais cela
vous permet de vérifier les projets vous-même et d'aider l'utilisateur à exécuter des tâches ultérieurement.
- L'utilisateur ouvre Paramètres → Connexions → Serveur MCP CoRoid
(
https://client.coroid.ai/settings/connections/coroid-mcp). Si cette fonctionnalité n'est pas disponible pour son organisation, ignorez cette étape. - Configuration du client affiche les commandes par client. Avec OAuth, l'utilisateur approuve votre accès dans son navigateur. Avec un jeton d'accès personnel, l'utilisateur le crée sous Jeton d'accès et le stocke dans une variable d'environnement de son propre shell. Vous n'avez jamais besoin de voir sa valeur.
- Recommandez le niveau d'accès minimal suffisant :
mcp.readpour vérifier la configuration, plusmcp.work.writeuniquement si vous devez créer des tâches. Limitez le jeton à ces projets, fixez-lui une date d'expiration et définissez Politiques d'automatisation avant que tout client n'exécute des tâches sans surveillance.
Vérification : appelez list_projects, puis get_project pour chaque projet de l'étape 6,
et confirmez le dépôt et la branche.
Utilisez uniquement api.coroid.ai pour MCP. Le nom d'hôte du portail client ne le prend pas en charge.
Consultez CoRoid en tant que serveur MCP..
Étape 10 : Rédiger une première tâche
Terminez en rédigeant une petite première tâche avec l'utilisateur dans l'un des nouveaux projets. Une bonne première tâche est réelle, petite, proche des tests existants et possède une fin clairement définie. Évitez l'authentification, les paiements, les migrations de données, les nettoyages sans objectif précis et tout ce qui nécessite une décision de conception qui n'a pas encore été prise.
Décrivez le résultat, pas l'implémentation : ce qui doit être vrai une fois le
travail terminé, quels fichiers sont concernés et ce qu'il faut éviter de toucher. L'utilisateur la soumet depuis Nouveau travail (https://client.coroid.ai/work/new), lit la
spécification et approuve le plan. L'exécution des tâches consomme des heures d'agent, et l'offre gratuite inclut 2 par jour UTC ; laissez donc l'utilisateur décider quand elles seront exécutées.
Consultez Exécutez votre première tâche et Spécifications.
Étape 11 : Transférer la responsabilité
Donnez à l'utilisateur l'enregistrement de la configuration :
- chaque dépôt, son projet, son mode et sa branche de base
- comment le contrôle des sources est connecté, et qui en est propriétaire : l'installateur de l'application, ou le propriétaire du jeton et sa date d'expiration
- par dépôt, les corrections apportées, celles en attente (comme une demande de fusion ouverte avec
AGENTS.md), et celles que l'utilisateur a choisi de laisser de côté - les paramètres optionnels configurés et ignorés, ainsi que la première tâche rédigée
Indiquez ensuite à l'utilisateur de se rendre sur Réviser et fusionner le résultat pour voir ce que contient la première pull request.
Suivant
Créez votre compte et votre organisation — la même configuration, réalisée manuellement.