Referencia · Plantillas

Plantillas

Las plantillas canónicas de current.md, history.md y meta.json y cómo se archiva la sesión.

current.md · history.md · meta.json

Las plantillas canónicas

.rei/templates/ contiene las tres plantillas de las que salen los archivos de estado: current.md, history.md y meta.json. Son la fuente única de formato y ningún agente debe inventar uno nuevo.

  • Las usa el CLI al iniciar la sesión, archivarla o restablecerla.
  • No se copian ni se escriben a mano: se generan y restablecen con rei.
  • Cambiar una plantilla a mano desincroniza los archivos que ya se generaron con ella.

current.md

current.md representa el estado actual de la sesión: qué Work Item está activo, en qué estado, qué plan queda, qué ha pasado y cuál es el próximo paso. Su plantilla fija cinco campos y tres secciones.

ParteContenido
CabeceraWork Item, Tipo, Estado, Inicio y Agente activo.
PlanPasos del trabajo, marcados a medida que avanzan.
BitácoraRegistro cronológico de lo ocurrido en la sesión.
Próximo pasoQué debe ocurrir a continuación.

El Spec Author lo inicializa con rei session start al empezar la planificación y lo deja en ready. El Implementer lo mantiene durante in_progress y lo deja en review. Se actualiza durante todo el ciclo, no solo al final.

Placeholders de la plantilla
{{WORK_ITEM}}
{{TYPE}}
{{STATE}}
{{START}}
{{AGENT}}
{{PLAN}}
{{LOG}}
{{NEXT}}

history.md

history.md es la bitácora histórica del proyecto y su contenido es append-only: las entradas anteriores nunca se modifican ni se eliminan. Cada entrada resume fecha, Work Item, agente, trabajo realizado, archivos modificados, verificación y estado final.

  • rei session archive añade el resumen de current.md al final del historial.
  • La entrada refleja el veredicto del Reviewer, porque el archivado ocurre después de rei status set <id> done.
  • No se reescribe una entrada para corregirla: si hace falta contexto, se añade una nueva.

meta.json

La plantilla de meta.json declara los ocho campos con placeholders que rellena el CLI al crear el Work Item. No es una lista de valores: el formato del id, los valores de type y status y el uso de los commits se documentan en la página de meta.json.

Placeholders de la plantilla
{
  "id": "{{ID}}",
  "title": "{{TITLE}}",
  "description": "{{DESCRIPTION}}",
  "type": "{{TYPE}}",
  "status": "{{STATUS}}",
  "created_at": "{{CREATED_AT}}",
  "base_commit": "{{BASE_COMMIT}}",
  "last_review_commit": "{{LAST_REVIEW_COMMIT}}"
}

Archivar la sesión

rei session archive mueve el resumen de current.md a history.md y restablece current.md a su estado inicial. Solo archiva cuando el Work Item está cerrado y el estado de la sesión es coherente.

  1. Comprueba que meta.json está en un estado terminal: done o blocked.
  2. Comprueba que el campo Estado de current.md coincide con el de meta.json.
  3. Si algo no coincide, rechaza el archivado con código 1 y explica la causa; no escribe nada.
  4. Si todo coincide, añade la entrada al final de history.md y restablece current.md.

rei session reset restablece current.md a su estado inicial sin archivar el historial. Se usa para descartar una sesión que no llegó a cerrarse, nunca para borrar evidencia de un Work Item terminado.

Aprobación de la planificación

Pendiente

La firma humana libera la hoja. El silencio no aprueba.

La aprobación se registra desde el CLI; el visor no la sustituye.