Uma ferramenta de CLI que gera arquivos README para seu repositório usando LLMs ou no modo offline, sem chave de API.
SupportPages-io/wtfm
Plugin para Claude Code e Codex que cria artigos de ajuda para usuários a partir do código-fonte, com capturas de tela renderizadas do próprio markup da interface.
- Estrelas
- 121
- Forks
- 10
- Issues abertas
- 7
- Último commit
- anteontem
O que é?
WTFM é um plugin para agentes de programação como Claude Code e Codex que cria documentação para usuários finais: tutoriais e guias de solução de problemas para quem usa um produto, não para quem o desenvolve. O agente lê o código-fonte relevante, extrai rotas, rótulos de botões e fluxos do código e escreve as instruções em linguagem simples.
Cada tela de um guia é apresentada com uma captura de tela. O WTFM recria mockups usando o markup, os estilos e a identidade visual do próprio projeto e os renderiza em PNG com uma instância local do Chromium headless, sem precisar executar o app nem fazer capturas manualmente. Os artigos são salvos em pastas com arquivos Markdown e as imagens correspondentes, e cada artigo passa por verificações de estrutura, texto e capturas de tela antes de ser salvo.
A ferramenta roda localmente com sua própria assinatura do agente. Publicar no SupportPages.io é opcional e só acontece quando você escolhe fazer isso. Há suporte para macOS e Linux; no Windows, é possível usar pelo WSL.
Recursos principais
- 01Cria artigos de tutoriais e solução de problemas a partir do código-fonte do projeto.
- 02Renderiza capturas de tela usando o markup, os estilos e a identidade visual do próprio projeto, sem executar o app.
- 03Gera arquivos Markdown simples, com as imagens salvas junto de cada artigo.
- 04Verifica a estrutura, o texto e as capturas de tela antes de salvar.
- 05Funciona com Claude Code ou Codex por meio de um comando de configuração executado uma única vez.
Casos de uso
- Escrever um guia para clientes que não conseguem encontrar um recurso no produto.
- Documentar tarefas administrativas, como convidar pessoas para a equipe ou alterar configurações.
- Criar artigos ilustrados de solução de problemas para uma central de ajuda.
- Manter a documentação para usuários no mesmo repositório que o código do produto.
Início rápido
- 1
Execute o script oficial de instalação do README
- 2
Configure seu computador
wtfm setup - 3
Configure seu projeto
wtfm init - 4
Peça ao Claude Code ou ao Codex para escrever um artigo no seu projeto
Antes de usar
- Compatível apenas com macOS e Linux; usuários do Windows precisam do WSL.
- É necessário ter o Claude Code ou o Codex instalado e conectado, além do Git.
- O Chromium para capturas de tela é baixado na primeira vez que você executa a configuração.
Em coleções
Tópicos
Perguntas frequentes
- O que é wtfm?
- Plugin para Claude Code e Codex que cria artigos de ajuda para usuários a partir do código-fonte, com capturas de tela renderizadas do próprio markup da interface. WTFM é um plugin para agentes de programação como Claude Code e Codex que cria documentação para usuários finais: tutoriais e guias de solução de problemas para quem usa um produto, não para quem o desenvolve. O agente lê o código-fonte relevante, extrai rotas, rótulos de botões e fluxos do código e escreve as instruções em linguagem simples.
- wtfm é gratuito? Qual é a licença?
- wtfm é open source sob a licença Apache-2.0. Confira os termos da licença antes de usá-lo em produtos comerciais.
- wtfm ainda é mantido?
- Manutenção ativa. O último commit de wtfm foi em 5 de nov. de 2026.
- Para que posso usar wtfm?
- Escrever um guia para clientes que não conseguem encontrar um recurso no produto. Documentar tarefas administrativas, como convidar pessoas para a equipe ou alterar configurações. Criar artigos ilustrados de solução de problemas para uma central de ajuda. Manter a documentação para usuários no mesmo repositório que o código do produto.
- Como instalar wtfm?
- Execute o script oficial de instalação do README Configure seu computador: wtfm setup Configure seu projeto: wtfm init Peça ao Claude Code ou ao Codex para escrever um artigo no seu projeto
- Onde consigo wtfm?
- O código-fonte e as instruções de instalação estão no GitHub: https://github.com/SupportPages-io/wtfm
Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.
Projetos relacionados
Uma interface local de revisão no navegador para anotar planos de agentes, Markdown, HTML e diffs de código e enviar feedback de volta aos agentes de programação.
Aplicativo web gratuito e auto-hospedado de base de conhecimento, desenvolvido com PHP e MySQL, com editor avançado de artigos e API JSON opcional somente para leitura.
Uma CLI em Rust para gerenciar git worktrees pelo nome da branch, feita para executar vários agentes de programação com IA em paralelo.
Um app de CLI para executar e alternar entre várias sessões de agentes de programação com IA em Git worktrees e projetos, sem tmux.
CLI e TUI para instalar, organizar e compartilhar uma biblioteca de skills para agentes de programação com IA, com uma seleção própria do autor incluída.