🚀 BIMMO – Spec-Driven Development (SDD) Generator

BIMMO é uma ferramenta CLI inteligente projetada para transformar ideias em documentação técnica completa e estruturada. Utilizando a metodologia SDD (Spec-Driven Development) e o poder da IA via OpenRouter, o BIMMO gera automaticamente todas as matrizes necessárias para iniciar seu projeto com o pé direito.

🛠️ Instalação

Como o projeto é uma ferramenta CLI em Node.js, você pode instalá-lo localmente para desenvolvimento:

1. Clone o repositório:

   git clone https://github.com/seu-usuario/bimmo.git
   cd sdd-generate

2. Instale as dependências:

   npm install

3. Compile o projeto:

   npm run build

4. Torne o comando bimmo global:

   npm link

🔑 Configuração Inicial

O BIMMO utiliza modelos da OpenRouter (como Gemini 2.0 Flash). Você precisa de uma chave de API para funcionar.

1. Obtenha sua chave em openrouter.ai.
2. Adicione ao seu terminal (ou ao seu arquivo .bashrc/.zshrc):

   export OPENROUTER_API_KEY='sua_chave_aqui'

📖 Guia de Uso (Primeiros Passos)

1. Criar um novo projeto

O primeiro passo é inicializar a estrutura do seu projeto. O BIMMO criará uma pasta com o nome escolhido no seu diretório atual.

bimmo new meu-novo-app
cd meu-novo-app

2. Gerar a documentação completa

Agora, descreva sua ideia em uma frase ou parágrafo. O BIMMO cuidará de gerar todas as matrizes (Spec, Plan, Tasks, etc).

bimmo generate all "Um sistema de gerenciamento de biblioteca com suporte a empréstimos e multas em Node.js"

3. Verificar o que foi criado

Você pode ver o progresso da sua documentação a qualquer momento:

bimmo status

📂 O que o BIMMO gera?

Dentro do seu projeto, você encontrará a pasta bimmo/ contendo:

| Matriz | Descrição | | :--- | :--- | | constitution.md | Missão, valores e diretrizes do projeto. | | spec.md | Especificação técnica detalhada (Funcionalidades e Restrições). | | plan.md | Plano de implementação dividido em fases e stack tecnológica. | | tasks.md | Lista de tarefas (Checklist) prontas para execução. | | data-model.md | Modelagem de dados, entidades e relacionamentos. | | research.md | Tópicos de pesquisa técnica e bibliotecas recomendadas. | | quickstart.md | Guia rápido para rodar o projeto localmente. | | state.json | O "cérebro" do projeto, permitindo retomar de onde parou. |

🦾 Comandos Úteis

• bimmo status: Mostra o que já foi gerado e o que falta.
• bimmo resume: Se a internet cair ou o limite de IA for atingido, use este comando para continuar a geração.
• bimmo teach: Exibe uma ajuda rápida sobre os comandos e o fluxo SDD.
• bimmo generate spec "<ideia>": Gera apenas a especificação (caso você queira validar o "o quê" antes do "como").

💡 Dica de Ouro

Se você receber um erro de Rate Limit (429) da OpenRouter, não se preocupe! O BIMMO tem um sistema de retry automático. Se ele parar de vez, basta rodar bimmo resume dentro da pasta do projeto para continuar exatamente de onde parou.

📄 Licença

Distribuído sob a licença MIT. Veja LICENSE para mais informações.