Início rápido

A CLI faz as partes mecânicas: o esqueleto, o frontmatter, a validação, o índice. Você faz a parte que só você pode fazer: decidir o que é o produto.

A ferramenta é opcional. O Framework, não.

Você pode escrever cada arquivo à mão. Não pule o .eidos/: é ele que te prende ao padrão. Sem ele, o template (o modelo) vive na sua cabeça e deriva a cada Blueprint (o plano).

1. Instale a CLI

   npm install -g eidosmd
   eidos --version

   Node 20 ou mais recente. Todos os comandos funcionam no Node 20; a busca da página do navegador usa texto completo do SQLite no Node 22.16 ou mais recente (ou no Node 24) e uma varredura em memória mais simples em um Node anterior. npx eidosmd funciona sem instalar.

2. Crie uma raiz

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

   Uma raiz é a pasta onde os seus Blueprints vivem. install copia um Framework (a estrutura) de partida (uma semente) para Blueprints/, mostra o plano e pergunta antes de escrever. Escolha a semente mais próxima; tudo o que ela te dá pode ser remodelado depois.

   Semente	Para
   @BuildableWorks/software	Um produto, serviço ou sistema em construção
   @BuildableWorks/book	Um livro, um argumento longo ou um curso
   @BuildableWorks/research	Uma pergunta, um estudo, um programa de investigação

   Decida duas coisas agora, porque as duas são incômodas de mudar depois: o nome da pasta raiz (Blueprints/ por padrão; qualquer nome funciona) e a convenção de nomes (--naming kebab-case, a padrão, TitleCase ou "Title Case"). Nomes →

   • DirectoryBlueprints/

     • README.md a porta de entrada
     • Directory.eidos/ o Framework

       • Framework.yaml pastas, propriedades, vocabulary, o índice
       • Directorytemplates/ um template de corpo por variant

         • …
       • Directoryroles/ como um agente fala com cada tipo de pessoa

         • …
       • me.md quem você é (local, ignorado pelo git)
     • Directoryassets/ imagens e documentos que os Blueprints linkam

       • …
     • Directoryframes/ o que é o produto inteiro: um frame em branco por tipo

       • …
     • Directoryspecs/ as unidades, agrupadas em um nível

       • Directoryidentity/

         • …

   install não escreve prosa. A linha do README, a descrição de cada grupo e cada frame são seus.

3. Diga quem você é

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

   Isso escreve .eidos/me.md. Um agente o lê antes de agir para decidir como responder. Em branco também serve. Papéis →

4. Preencha os frames

   Os frames (os enquadramentos) descrevem o produto inteiro: para software, sua arquitetura, audiência, critérios e mercado. Todos os outros Blueprints são julgados contra eles. Preencha o que se sabe; deixe o resto. Frames →

5. Monte um Blueprint

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

   O arquivo nasce conforme: o frontmatter a partir das propriedades que se aplicam a specs, o corpo do template micro, o nome do arquivo na sua convenção, um id permanente dentro. Comece pela variant (a variante) leve; cresça para full quando as seções mais completas merecerem o lugar.

6. Escreva

   Abra o arquivo e percorra as seções. Duas coisas decidem se ele é bom:

   • Comece por ## Intent: por que isso existe, e quem tem o problema. Se a intenção mudar substancialmente, você tem outro Blueprint.
   • Escreva ## Out of Scope em segundo lugar, não por último. É onde o escopo se sustenta. Por quê →

   Nenhuma ferramenta fará esta parte. new monta o esqueleto, check relata, um agente pergunta e formata. Nenhum deles decide o que é o produto. Trabalhando com agentes →

7. Verifique, indexe, navegue, faça commit

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

   check relata o que falta ou está malformado: uma revisão para agir em cima, não uma barreira. index reconstrói o índice dentro do Framework.yaml. Para navegar pela raiz, abra a pasta dela no Eidos MD. Faça commit de tudo; o .gitignore da semente deixa o me.md de fora.

Com um agente

eidos agents --write

Isso deixa uma nota curta no AGENTS.md para que qualquer agente de código com um shell leia eidos instructions antes de tocar em um Blueprint. Agentes →

A partir daqui

• Escrevendo um Blueprint: a mecânica.
• Moldando o seu Framework: quando a semente deixa de servir.
• Comandos: todas as opções.