Inicio rápido

La CLI hace las partes mecánicas: el andamiaje, el frontmatter, la validación, el índice. Tú haces la parte que solo tú puedes hacer: decidir qué es el producto.

Las herramientas son opcionales. El Framework no.

Puedes escribir cada archivo a mano. No te saltes .eidos/: es lo que te sujeta al estándar. Sin él, el template (la plantilla) vive en tu cabeza y va a la deriva con cada Blueprint (el plano).

1. Instala la CLI

   npm install -g eidosmd
   eidos --version

   Node 20 o más reciente. Todos los comandos funcionan en Node 20; la búsqueda de la página del navegador usa texto completo de SQLite en Node 22.16 o más reciente (o Node 24) y un barrido en memoria más simple en un Node anterior. npx eidosmd funciona sin instalar.

2. Crea una raíz

   eidos install @BuildableWorks/software --group identity --product "My Product"

   Una raíz es la carpeta donde viven tus Blueprints. install copia un Framework (el marco) de partida (una semilla) en Blueprints/, muestra su plan y pregunta antes de escribir. Elige la semilla más cercana; todo lo que te da se puede remodelar después.

   Semilla	Para
   @BuildableWorks/software	Un producto, servicio o sistema en construcción
   @BuildableWorks/book	Un libro, un argumento largo o un curso
   @BuildableWorks/research	Una pregunta, un estudio, un programa de investigación

   Decide dos cosas ahora, porque las dos son incómodas de cambiar después: el nombre de la carpeta raíz (Blueprints/ por defecto; vale cualquier nombre) y la convención de nombres (--naming kebab-case, la predeterminada, TitleCase o "Title Case"). Nombres →

   • DirectorioBlueprints/

     • README.md la puerta de entrada
     • Directorio.eidos/ el Framework

       • Framework.yaml carpetas, propiedades, vocabulary, el índice
       • Directoriotemplates/ un template de cuerpo por variant

         • …
       • Directorioroles/ cómo le habla un agente a cada tipo de persona

         • …
       • me.md quién eres (local, ignorado por git)
     • Directorioassets/ imágenes y documentos que enlazan los Blueprints

       • …
     • Directorioframes/ qué es el producto entero: un frame en blanco por tipo

       • …
     • Directoriospecs/ las unidades, agrupadas a un nivel

       • Directorioidentity/

         • …

   install no escribe prosa. La línea del README, la descripción de cada grupo y cada frame son tuyos.

3. Di quién eres

   eidos roles
   eidos whoami --role developer --ownership "the whole product" --experience deep --capacity fluent

   Esto escribe .eidos/me.md. Un agente lo lee antes de actuar para decidir cómo responder. En blanco también vale. Roles →

4. Rellena los frames

   Los frames (los encuadres) describen el producto entero: para software, su arquitectura, audiencia, criterios y mercado. Todos los demás Blueprints se juzgan contra ellos. Rellena lo que se sabe; deja el resto. Frames →

5. Levanta un Blueprint

   eidos new specs "Resume Playback" --group identity --variant micro --summary "Returns a viewer to the exact second they stopped."

   El archivo nace conforme: el frontmatter a partir de las propiedades que aplican a specs, el cuerpo del template micro, el nombre de archivo en tu convención, un id permanente dentro. Empieza por la variant (la variante) ligera; crece hacia full cuando las secciones más completas se ganen su sitio.

6. Escríbelo

   Abre el archivo y recorre las secciones. Dos cosas deciden si es bueno:

   • Empieza por ## Intent: por qué existe esto, y quién tiene el problema. Si la intención cambia sustancialmente, tienes otro Blueprint.
   • Escribe ## Out of Scope en segundo lugar, no al final. Es donde se sostiene el alcance. Por qué →

   Ninguna herramienta hará esta parte. new levanta la estructura, check informa, un agente pregunta y da formato. Ninguno decide qué es el producto. Trabajar con agentes →

7. Comprueba, indexa, navega, haz commit

   eidos check
   eidos index
   git add Blueprints && git commit -m "add product blueprints"

   check informa de lo que falta o está mal formado: una revisión sobre la que actuar, no una barrera. index reconstruye el índice dentro de Framework.yaml. Para navegar la raíz, abre su carpeta en Eidos MD. Haz commit de todo; el .gitignore de la semilla deja fuera me.md.

Con un agente

eidos agents --write

Esto deja una nota breve en AGENTS.md para que cualquier agente de código con una terminal lea eidos instructions antes de tocar un Blueprint. Agentes →

A partir de aquí

• Escribir un Blueprint: la mecánica.
• Dar forma a tu Framework: cuando la semilla deja de encajar.
• Comandos: todas las opciones.