Tutoriels

Démarrer un projet avec /init et AGENTS.md

Donnez à Bob un contexte de projet persistant à travers les conversations et les modes avec /init, qui génère automatiquement des fichiers AGENTS.md.

La commande /init analyse un projet et génère un fichier de résumé structuré appelé AGENTS.md que Bob utilise comme contexte persistant dans chaque conversation. La commande /init est la façon dont vous donnez à Bob des connaissances sur la structure, les conventions et la base de code d'un projet, sans exiger que Bob relise chaque fichier au début de chaque interaction.

Les grands modèles de langage sont sans état. Chaque nouvelle conversation commence sans mémoire des interactions précédentes. Sans contexte de projet explicite, Bob doit découvrir la base de code à chaque nouvelle interaction, ce qui est inefficace et devient impraticable à grande échelle.

Dans ce tutoriel, vous initialisez Bob dans le répertoire racine d'une application de démonstration, explorez le contexte que Bob obtient sur l'application et découvrez la structure de Bob pour le contexte spécifique au mode.

Prérequis

Pour compléter ce tutoriel, vous avez besoin des éléments suivants :

  • Si vous ne l'avez pas déjà, clonez le code de démonstration Galaxium Travels. La commande de clonage extrait également la branche bob-learning-path-branch qui contient le code que vous utilisez dans les tutoriels.
git clone -b bob-learning-path-branch https://github.com/IBM/galaxium-travels
  • Bob IDE avec le code de démonstration Galaxium Travels ouvert
  • Bien que non obligatoire, envisagez de faire le tutoriel de démarrage rapide pour vous familiariser avec l'interface et les fonctionnalités de Bob.

Exécuter /init

Pour initialiser le contexte du projet, naviguez vers la barre latérale de chat Bonjour, je suis Bob dans Bob IDE. Basculez vers le mode Agent en bas de la barre latérale.

Basculer vers le mode Agent

Entrez la commande /init dans la barre latérale de chat. Si vous avez désactivé l'approbation automatique, Bob demande votre permission pour lire les fichiers et écrire les fichiers AGENTS.md.

 /init

Exécution de la commande /init dans Bob IDE

Bob lit les fichiers pertinents dans le projet. Bob génère ensuite le fichier principal AGENTS.md dans le répertoire racine de Galaxium Travels. Bob crée également un dossier .bob qui contient un AGENTS.md pour chaque mode.

Explorer les fichiers AGENTS.md

Les fichiers AGENTS.md fonctionnent comme une documentation d'intégration pour Bob. AGENTS.md est un résumé concis et exploitable qui fournit tout ce dont Bob a besoin pour comprendre la structure et les conventions du projet.

Vous pouvez localiser le fichier principal AGENTS.md en bas de l'explorateur de fichiers Bob sur le côté gauche. Ouvrez le fichier pour lire son contenu.

Le fichier AGENTS.md dans l'explorateur de fichiers Bob

Le fichier AGENTS.md contient généralement les composants suivants :

  • Aperçu et objectif du projet
  • Structure des répertoires et emplacements des fichiers clés
  • Pile technologique et dépendances
  • Modèles architecturaux et conventions
  • Flux de travail de développement

Bob applique automatiquement le AGENTS.md aux nouvelles conversations et apprend le contexte du projet.

Fichiers AGENTS.md spécifiques au mode

En plus du AGENTS.md principal dans le répertoire racine de Galaxium Travels, /init génère des fichiers de contexte spécifiques au mode dans le dossier .bob pour chaque mode intégré :

FichierMode
.bob/rules-code/AGENTS-code.mdMode Agent
.bob/rules-plan/AGENTS-plan.mdMode Plan
.bob/rules-ask/AGENTS-ask.mdMode Ask

Le contexte du mode Plan met l'accent sur les conventions architecturales, tandis que le contexte du mode Code met en évidence la structure des fichiers et les modèles de nommage.

Maintenir les fichiers AGENTS.md

Réexécutez /init après avoir effectué les ajustements de projet suivants :

  • Ajout de nouveaux modules ou services
  • Modification de la structure des répertoires
  • Adoption de nouvelles technologies ou frameworks
  • Intégration de nouveaux membres de l'équipe qui utiliseront Bob

Vous pouvez également modifier manuellement le AGENTS.md pour ajouter un contexte que l'analyse automatisée de Bob pourrait ne pas capturer, comme les règles métier, les conventions de déploiement ou les pratiques spécifiques à l'équipe.

Prochaines étapes

Dans ce tutoriel, vous avez appris ce qui suit :

  • Les grands modèles de langage sont sans état. L'exécution de la commande /init résout ce problème en générant AGENTS.md, qui est un fichier de contexte persistant que Bob lit au début de chaque conversation.
  • Les fichiers AGENTS.md spécifiques au mode fournissent un contexte ciblé pour les modes Agent, Plan et Ask.
  • Réexécutez /init après des changements majeurs du projet pour maintenir le contexte à jour.
Comment trouvez-vous ce sujet ?