Pitch: Criei o RepoXray: uma CLI em Go para fazer um “raio-x” de projetos open-source
Nos últimos dias eu comecei um projeto open-source chamado RepoXray.
A ideia nasceu de uma pergunta simples:
Como saber se um repositório open-source está realmente preparado para receber usuários, contribuidores e confiança da comunidade?
Muitos projetos têm código bom, mas falham em coisas básicas:
- não têm licença clara;
- não têm CI;
- não têm
CONTRIBUTING.md; - não têm
SECURITY.md; - não têm templates de issue ou pull request;
- não deixam claro como alguém pode contribuir;
- não mostram sinais mínimos de maturidade.
E isso importa.
Porque open-source não é só código.
Open-source também é manutenção, confiança, documentação, segurança, onboarding e previsibilidade.
Foi daí que surgiu o RepoXray.
O que é o RepoXray?
O RepoXray é uma CLI escrita em Go que analisa um repositório e gera um relatório de saúde, maturidade e manutenibilidade.
A ideia é funcionar como um “raio-x” do projeto.
Você roda:
repoxray scan .
Ou analisa um repositório remoto:
repoxray scan github.com/owner/repo
E recebe um relatório com:
- score de maturidade;
- pontos fortes;
- warnings;
- problemas críticos;
- recomendações práticas;
- sinais ausentes no projeto.
Exemplo de coisas que ele verifica:
README.md;- licença;
- arquivos de pacote como
go.mod,package.json,Cargo.toml; - testes;
- Git repository;
- GitHub Actions;
CONTRIBUTING.md;CODE_OF_CONDUCT.md;SECURITY.md;- issue templates;
- pull request template.
Por que isso existe?
Porque muitos projetos open-source são avaliados de forma subjetiva.
Às vezes olhamos estrelas, número de commits ou popularidade. Mas esses sinais nem sempre dizem se o projeto é saudável.
Um projeto pode ter muitas estrelas e ainda assim ser difícil de contribuir.
Um projeto pode ter código excelente e ainda assim não ter licença.
Um projeto pode parecer ativo, mas não ter CI, política de segurança ou documentação para novos contribuidores.
O RepoXray tenta transformar esses sinais em algo visível.
Não é uma ferramenta para “julgar” projetos.
É uma ferramenta para ajudar maintainers e contribuidores a enxergarem o que pode melhorar.
O que ele muda para projetos open-source?
Para maintainers, ele pode servir como checklist inicial de maturidade.
Antes de divulgar um projeto, você pode rodar o RepoXray e perguntar:
Meu projeto está minimamente preparado para receber usuários e contribuidores?
Para contribuidores, ele ajuda a entender se um repositório tem sinais bons de manutenção.
Para empresas ou times, ele pode ser usado como uma primeira leitura da saúde de projetos internos ou dependências open-source.
Para quem está começando no open-source, ele também funciona como ferramenta educativa: mostra quais arquivos e práticas fazem um projeto parecer mais confiável.
O projeto ainda está no começo
O RepoXray está em fase inicial.
A primeira versão ainda é simples e determinística. Ele não usa IA, não envia dados para APIs externas e não tenta fazer uma análise mágica do projeto.
Ele verifica sinais objetivos.
Arquivo existe?
Tem CI?
Tem licença?
Tem política de segurança?
Tem templates?
Tem testes?
A ideia é começar simples e evoluir com o tempo.
Algumas coisas que quero adicionar depois:
- análise mais profunda de GitHub Actions;
- suporte melhor para múltiplas licenças;
- relatórios em JSON e Markdown;
- comparação entre repositórios;
- análise de dependências;
- badge de maturidade;
- integração com GitHub API;
- recomendações mais contextuais;
- scoring por categorias, como documentação, segurança, CI e contributor readiness.
Por que Go?
Escolhi Go porque queria uma ferramenta simples, rápida, fácil de instalar e fácil de distribuir.
RepoXray não precisa ser complexo para ser útil.
A proposta é ser uma CLI direta:
repoxray scan github.com/realknove/repoxray
E pronto: você recebe um diagnóstico prático.
O que eu quero com esse projeto
Meu objetivo é construir uma ferramenta open-source pequena, útil e bem mantida.
Não quero que o RepoXray seja só mais uma CLI esquecida.
Quero que ele vire uma forma simples de responder:
“Esse projeto está pronto para crescer?”
E também:
“O que falta para ele parecer mais confiável para a comunidade?”
Open-source precisa de código bom, mas também precisa de estrutura.
O RepoXray tenta ajudar nessa segunda parte.
Repositório
O projeto está aqui:
https://github.com/realknove/repoxray/
Ainda está no começo, então feedback é muito bem-vindo.
Se você mantém um projeto open-source, rode o RepoXray e veja o que ele aponta.
Se você contribui com open-source, talvez ele ajude a enxergar melhor o que torna um projeto saudável.
E se você quiser contribuir com ideias, checks novos ou melhorias no scoring, vou gostar bastante de receber feedback.