Iniciar un proyecto con /init y AGENTS.md
Proporcione a Bob contexto de proyecto persistente a través de conversaciones y modos con /init, que genera automáticamente archivos AGENTS.md.
El comando /init escanea un proyecto y genera un archivo de resumen estructurado llamado AGENTS.md que Bob utiliza como contexto persistente en cada conversación. El comando /init es cómo le proporciona a Bob conocimiento sobre la estructura, convenciones y base de código de un proyecto, sin requerir que Bob vuelva a leer cada archivo al inicio de cada interacción.
Los modelos de lenguaje grandes no tienen estado. Cada nueva conversación comienza sin memoria de interacciones anteriores. Sin contexto de proyecto explícito, Bob debe descubrir la base de código con cada nueva interacción, lo cual es ineficiente y se vuelve impráctico a escala.
En este tutorial, inicializa Bob en el directorio raíz de una aplicación de demostración, explora el contexto que Bob obtiene sobre la aplicación y aprende sobre la estructura de Bob para contexto específico de modo.
Requisitos previos
Para completar este tutorial, necesita lo siguiente:
- Si aún no lo tiene, clone el código de demostración de Galaxium Travels. El comando de clonación también verifica la rama
bob-learning-path-branchque contiene el código que utiliza en los tutoriales.
git clone -b bob-learning-path-branch https://github.com/IBM/galaxium-travels- Bob IDE con el código de demostración de Galaxium Travels abierto
- Aunque no es obligatorio, considere realizar el tutorial de inicio rápido para familiarizarse con la interfaz y las características de Bob.
Ejecutar /init
Para inicializar el contexto del proyecto, navegue a la barra lateral de chat Hola, soy Bob en Bob IDE. Cambie al modo Agent en la parte inferior de la barra lateral.
Ingrese el comando /init en la barra lateral de chat. Si tiene la aprobación automática deshabilitada, Bob solicita su permiso para leer archivos y escribir los archivos AGENTS.md.
/init
Bob lee los archivos relevantes en el proyecto. Luego, Bob genera el archivo principal AGENTS.md en el directorio raíz de Galaxium Travels. Bob también crea una carpeta .bob que contiene un AGENTS.md para cada modo.
Explorar archivos AGENTS.md
Los archivos AGENTS.md funcionan como documentación de incorporación para Bob. AGENTS.md es un resumen conciso y procesable que proporciona todo lo que Bob necesita para comprender la estructura y las convenciones del proyecto.
Puede ubicar el archivo principal AGENTS.md en la parte inferior del explorador de archivos de Bob en el lado izquierdo. Abra el archivo para leer su contenido.
El archivo AGENTS.md generalmente contiene los siguientes componentes:
- Descripción general y propósito del proyecto
- Estructura de directorios y ubicaciones de archivos clave
- Pila de tecnología y dependencias
- Patrones arquitectónicos y convenciones
- Flujos de trabajo de desarrollo
Bob aplica automáticamente el AGENTS.md a nuevas conversaciones y aprende el contexto del proyecto.
Archivos AGENTS.md específicos de modo
Además del AGENTS.md principal en el directorio raíz de Galaxium Travels, /init genera archivos de contexto específicos de modo en la carpeta .bob para cada modo integrado:
| Archivo | Modo |
|---|---|
.bob/rules-code/AGENTS-code.md | Modo Agent |
.bob/rules-plan/AGENTS-plan.md | Modo Plan |
.bob/rules-ask/AGENTS-ask.md | Modo Ask |
El contexto del modo Plan enfatiza las convenciones arquitectónicas, mientras que el contexto del modo Code destaca la estructura de archivos y los patrones de nomenclatura.
Mantener los archivos AGENTS.md
Vuelva a ejecutar /init después de realizar los siguientes ajustes del proyecto:
- Agregar nuevos módulos o servicios
- Cambiar la estructura de directorios
- Adoptar nuevas tecnologías o frameworks
- Incorporar nuevos miembros del equipo que usarán Bob
También puede editar manualmente el AGENTS.md para agregar contexto que el escaneo automatizado de Bob podría no capturar, como reglas de negocio, convenciones de implementación o prácticas específicas del equipo.
Próximos pasos
En este tutorial, aprendió lo siguiente:
- Los modelos de lenguaje grandes no tienen estado. Ejecutar el comando
/initresuelve este problema generandoAGENTS.md, que es un archivo de contexto persistente que Bob lee al inicio de cada conversación. - Los archivos
AGENTS.mdespecíficos de modo proporcionan contexto dirigido para los modos Agent, Plan y Ask. - Vuelva a ejecutar
/initdespués de cambios importantes del proyecto para mantener el contexto actualizado.