Iniciar un proyecto con /init y AGENTS.md en Bob Shell

Ejecuta el comando /init de Bob Shell para generar AGENTS.md, un archivo de contexto de proyecto que Bob carga en cada conversación, y aprende a mantener ese contexto actualizado.

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 la forma de proporcionarle 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 son sin estado (stateless). Cada nueva conversación comienza sin memoria de interacciones previas. Sin un 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 poco práctico a escala.

En este tutorial, inicializas Bob Shell en el directorio raíz de una aplicación de demostración, exploras el contexto que Bob adquiere sobre la aplicación y aprendes cómo Bob Shell carga los archivos AGENTS.md.

Prerrequisitos

Para completar este tutorial, necesitas lo siguiente:

  • Si aún no lo tienes, clona el código de demostración de Galaxium Travels. El comando de clonación también descarga la rama bob-learning-path-branch que contiene el código que usas en los tutoriales.
    git clone -b bob-learning-path-branch https://github.com/IBM/galaxium-travels
  • Aunque no es obligatorio, considera leer Iniciar una sesión interactiva para familiarizarte con la interfaz y las funciones de Bob Shell.

Iniciar Bob Shell en el proyecto

Cambia al directorio raíz de Galaxium Travels:

cd galaxium-travels

Inicia una sesión interactiva:

bob chat --mode agent

El indicador --mode agent inicia la sesión en modo Agent, que cuenta con las herramientas que Bob necesita para leer archivos y escribir AGENTS.md.

Si Bob Shell te pregunta si confías en la carpeta, confía en ella para que Bob pueda trabajar en el proyecto. Para obtener más información, consulta Carpetas de confianza.

Generar AGENTS.md con /init

Introduce el comando /init en el prompt:

/init

Bob lee los archivos relevantes del proyecto.

Cuando Bob solicite usar una herramienta, como leer archivos o escribir AGENTS.md, aparecerá el diálogo de aprobación. Selecciona Approve para cada solicitud.

Bob genera el archivo principal AGENTS.md en el directorio raíz de Galaxium Travels. También genera archivos de contexto específicos de cada modo en .bob/rules-agent/AGENTS.md, .bob/rules-ask/AGENTS.md y .bob/rules-plan/AGENTS.md.

Explorar los archivos AGENTS.md

El archivo AGENTS.md es documentación de incorporación (onboarding) para Bob. Es un resumen conciso y práctico que proporciona todo lo que Bob necesita para comprender la estructura y las convenciones del proyecto.

Pídele a Bob que te muestre el archivo:

Show me the contents of @AGENTS.md

El símbolo @ hace referencia a un archivo de tu proyecto, por lo que Bob lo lee antes de responder. También puedes abrir otra terminal y ver el archivo directamente:

cat AGENTS.md

El archivo AGENTS.md normalmente contiene los siguientes componentes:

  • Descripción general y propósito del proyecto
  • Estructura de directorios y ubicaciones de archivos clave
  • Stack tecnológico y dependencias
  • Patrones arquitectónicos y convenciones
  • Flujos de trabajo de desarrollo

Para ver todos los archivos que /init creó, ejecuta git status en el directorio de Galaxium Travels:

git status

Cómo carga Bob Shell los archivos AGENTS.md

Bob Shell carga automáticamente archivos de contexto como AGENTS.md al inicio de cada tarea.

  1. Contexto global: ~/.bob/AGENTS.md se aplica a todos los proyectos.
  2. Contexto del proyecto: AGENTS.md en la raíz del proyecto y directorios principales se aplica al proyecto.
  3. Contexto local: AGENTS.md en subdirectorios se aplica a ese subdirectorio, para instrucciones específicas de componentes.

Para darle instrucciones a Bob para un solo modo, añade reglas específicas de modo en directorios .bob/rules-<mode>/, como .bob/rules-plan/ para el modo Plan.

Mantener los archivos AGENTS.md

Vuelve a ejecutar /init después de los siguientes cambios:

  • Añadir nuevos módulos o servicios
  • Cambiar la estructura de directorios
  • Adoptar nuevas tecnologías o frameworks
  • Incorporar nuevos miembros al equipo que usen Bob

También puedes editar manualmente AGENTS.md para añadir contexto que el escaneo automatizado de Bob podría no capturar, como reglas de negocio, convenciones de despliegue o prácticas específicas del equipo. Haz commit de AGENTS.md en el control de versiones para que tu equipo comparta el mismo contexto.

Próximos pasos

En este tutorial, aprendiste lo siguiente:

  • Los modelos de lenguaje grandes son sin estado. Ejecutar el comando /init soluciona este problema generando AGENTS.md, que es un archivo de contexto persistente que Bob lee al inicio de cada conversación.
  • Vuelve a ejecutar /init tras cambios importantes en el proyecto para mantener el contexto actualizado.

Avanza a Escribir prompts efectivos para Bob Shell para aprender a escribir prompts que produzcan de forma confiable el output que deseas.

¿Cómo es este tema?