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

Lance la commande /init de Bob Shell pour générer AGENTS.md, un fichier de contexte de projet que Bob charge à chaque conversation, et apprends à maintenir ce contexte à jour.

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 tu donnes à Bob une connaissance de la structure, des conventions et de la base de code d'un projet, sans que Bob ait à relire 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, tu initialises Bob Shell dans le répertoire racine d'une application de démonstration, explores le contexte que Bob acquiert sur l'application, et apprends comment Bob Shell charge les fichiers AGENTS.md.

Prérequis

Pour compléter ce tutoriel, tu as besoin des éléments suivants :

  • Si tu ne l'as pas encore, clone le code de démonstration Galaxium Travels. La commande clone extrait également le branch bob-learning-path-branch qui contient le code utilisé dans les tutoriels.
    git clone -b bob-learning-path-branch https://github.com/IBM/galaxium-travels
  • Bien que ce ne soit pas obligatoire, pense à lire Démarrer une session interactive pour te familiariser avec l'interface et les fonctionnalités de Bob Shell.

Démarrer Bob Shell dans le projet

Accède au répertoire racine de Galaxium Travels :

cd galaxium-travels

Démarre une session interactive :

bob chat --mode agent

Le flag --mode agent démarre la session en mode Agent, qui dispose des outils dont Bob a besoin pour lire des fichiers et écrire AGENTS.md.

Si Bob Shell demande si tu fais confiance au dossier, fais-lui confiance pour que Bob puisse travailler dans le projet. Pour en savoir plus, consulte Dossiers de confiance.

Générer AGENTS.md avec /init

Saisis la commande /init à l'invite :

/init

Bob lit les fichiers pertinents du projet.

Quand Bob demande à utiliser un outil, comme lire des fichiers ou écrire AGENTS.md, la boîte de dialogue d'approbation apparaît. Sélectionne Approve pour chaque demande.

Bob génère le fichier principal AGENTS.md dans le répertoire racine de Galaxium Travels. Il génère également des fichiers de contexte spécifiques aux modes dans .bob/rules-agent/AGENTS.md, .bob/rules-ask/AGENTS.md et .bob/rules-plan/AGENTS.md.

Explorer les fichiers AGENTS.md

Le fichier AGENTS.md est une documentation d'intégration pour Bob. C'est un résumé concis et actionnable qui fournit à Bob tout ce dont il a besoin pour comprendre la structure et les conventions du projet.

Demande à Bob de te montrer le fichier :

Show me the contents of @AGENTS.md

Le symbole @ référence un fichier dans ton projet, donc Bob le lit avant de répondre. Tu peux aussi ouvrir un autre terminal et afficher le fichier directement :

cat AGENTS.md

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

  • Vue d'ensemble du projet et son objectif
  • Structure des répertoires et emplacements des fichiers clés
  • Stack technologique et dépendances
  • Patterns architecturaux et conventions
  • Workflows de développement

Pour voir tous les fichiers créés par /init, lance git status dans le répertoire Galaxium Travels :

git status

Comment Bob Shell charge les fichiers AGENTS.md

Bob Shell charge automatiquement les fichiers de contexte comme AGENTS.md au début de chaque tâche.

  1. Contexte global : ~/.bob/AGENTS.md s'applique à tous les projets.
  2. Contexte de projet : AGENTS.md dans la racine du projet et les répertoires parents s'applique au projet.
  3. Contexte local : AGENTS.md dans les sous-répertoires s'applique à ce sous-répertoire, pour les instructions spécifiques aux composants.

Pour donner à Bob des instructions pour un seul mode, ajoute des règles spécifiques au mode dans les répertoires .bob/rules-<mode>/, comme .bob/rules-plan/ pour le mode Plan.

Maintenir les fichiers AGENTS.md

Relance /init après les changements 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 d'équipe qui utilisent Bob

Tu peux aussi modifier manuellement AGENTS.md pour ajouter du contexte que le scan automatique de Bob pourrait ne pas capturer, comme des règles métier, des conventions de déploiement ou des pratiques spécifiques à l'équipe. Committe AGENTS.md dans le contrôle de version pour que ton équipe partage le même contexte.

Prochaines étapes

Dans ce tutoriel, tu as appris ce qui suit :

  • Les grands modèles de langage sont sans état. La commande /init résout ce problème en générant AGENTS.md, un fichier de contexte persistant que Bob lit au début de chaque conversation.
  • Relance /init après des changements majeurs du projet pour garder le contexte à jour.

Passe à Écrire des prompts efficaces pour Bob Shell pour apprendre à écrire des prompts qui produisent de manière fiable le résultat que tu veux.

Comment trouvez-vous ce sujet ?