Pipemap
Documentação viva dos fluxos do seu sistema, dentro do próprio editor.
Você abre um arquivo .yaml e vê um diagrama interativo. Edita o diagrama e o arquivo atualiza. Pede pra IA documentar um fluxo e ela conduz uma entrevista estruturada, gerando o YAML pronto. Sem ferramenta externa, sem desenho que envelhece, sem doc que ninguém lê.
Funciona no VSCode, Cursor e Antigravity.
O problema que resolve
Times param de documentar pipelines porque:
- Diagrama em Miro / Excalidraw / Lucid envelhece em duas semanas.
- Doc em Notion / Confluence, ninguém abre na hora de debugar.
- Mermaid / PlantUML é rápido de escrever, mas frio de ler.
- IA que você pede pra "documentar isso aí" alucina nome de função e arquivo.
Pipemap troca tudo isso por um único arquivo YAML versionado junto com o código, renderizado como diagrama bonito direto no IDE, com uma IA que entrevista você ao invés de inventar.
Como funciona
Abra o chat do seu IDE e diga ao agente Pipemap Architect o que você quer documentar. Ele conduz uma entrevista de 5 fases, pergunta o que precisa, pede confirmação antes de escrever, e gera o pipemap.yaml direto no projeto.
Nada de chutar nome de função. Se a IA não souber, ela pergunta.
2. Edite visualmente
Arraste nodes, conecte etapas, agrupe em lanes, abra detalhes em painel lateral, edite tudo com clique duplo. Cada mudança salva no YAML automaticamente. Reabriu o arquivo? Voltou exatamente onde estava.
3. Alterne entre código e diagrama
Um botão no topo do editor: vai do diagrama interativo pro YAML cru e volta. Equipe que prefere texto edita o YAML; quem prefere visual edita o board. Mesmo arquivo, duas formas de ver.
4. Validação que protege a doc
O schema é fechado. Tipo de node inválido, edge apontando pra lugar nenhum, seção mal-formatada: tudo é rejeitado com mensagem clara apontando o problema. Doc inválida nunca entra no repositório.
Principais recursos
- Board interativo com drag de nodes, desenho de edges, lanes coloridas, marquee selection, undo / redo, atalhos de teclado.
- Painel lateral rico por etapa: chave-valor, prosa em markdown, chips, entrada / saída, blocos de código, links, alertas coloridos.
- Persona Pipemap Architect via chat do IDE, com skill estruturada em 5 fases pra extrair contexto sem alucinar.
- MCP server embarcado que dá às IAs do seu IDE (Copilot, Cursor, Antigravity) acesso direto ao schema, ao pipeline atual e às ferramentas de validação e edição.
- Pan e zoom com mouse, trackpad, ou clicando e arrastando com o botão direito.
- Layout persistente salvo em sidecar
pipemap.layout.json (não polui o YAML com coordenadas).
- Suporte a
pipemap.yaml, *.pipemap.yaml e *.pipemap como tipos reconhecidos.
Começando
- Instale a extensão no seu IDE.
- Abra um projeto e rode o comando Pipemap: Initialize pipemap.yaml pela paleta (Ctrl+Shift+P).
- A extensão registra o MCP server no workspace e cria um
pipemap.yaml mínimo.
- Reinicie o IDE pra carregar o MCP. Reabra o
pipemap.yaml: o board aparece.
- No chat, peça pro @pipemap documentar um fluxo do seu projeto.
Atalhos úteis
| Ação |
Atalho |
| Pan do board |
Clicar e arrastar com botão direito, ou pressionar a roda do mouse |
| Menu contextual |
Clicar com botão direito sem arrastar |
| Selecionar mais de um |
Shift + clique |
| Seleção retangular |
Clicar e arrastar no canvas vazio |
| Abrir detalhes |
Duplo clique em node |
| Editar texto no lugar |
Duplo clique em label ou subtítulo |
| Salvar |
Ctrl+S (autosave em mutações) |
Filosofia
Pipemap é open-source, MIT, e roda 100% local. Nenhum dado sai do seu workspace. O arquivo pipemap.yaml é seu, vive no Git ao lado do código, e funciona como fonte única da verdade do fluxo. A extensão é só o visualizador e editor; o arquivo continua legível em qualquer editor de texto.
Licença
MIT.
