ossperks check
Verifique automaticamente se o seu repositório se qualifica para programas de benefícios OSS.
Uso
ossperks check [opções]Alias: ossperks ck
Execute dentro de qualquer repositório Git. Nenhum argumento ou token necessário para repositórios públicos.
Opções
| Flag | Descrição |
|---|---|
--repo <owner/repo> | Especificar explicitamente um repositório (ex.: vercel/next.js) |
--provider <provider> | Provedor Git: github, gitlab, codeberg ou gitea (padrão: github) |
-p, --program <id> | Verificar apenas um programa específico (ex.: --program vercel) |
-i, --interactive | Escolher programas interativamente (agrupados por categoria; apenas TTY, não com --json ou --program) |
--json | Exibir JSON bruto |
-h, --help | Exibir ajuda |
Como funciona
ossperks check executa completamente automático:
ossperks check
│
▼
Lê package.json (campo repository)
│ ← não encontrado?
▼
Lê .git/config (remote.origin.url)
│
▼
Detecta provedor (github.com / gitlab.com / codeberg.org / gitea.com)
│
├─ GitHub → GET /repos/:owner/:repo
├─ GitLab → GET /api/v4/projects/:id
├─ Codeberg → GET /api/v1/repos/:owner/:repo
└─ Gitea → GET /api/v1/repos/:owner/:repo
│
▼
RepoContext (estrelas, licença, idade, atividade...)
│
▼
Verifica regras de elegibilidade para cada programa
│
▼
Exibe resultadosDetecção de repositório
Quando --repo não é especificado, a ferramenta lê a URL do seu repositório de um dos dois lugares, nesta ordem:
- Campo
repositoryempackage.json remote.origin.urlem.git/config
Formatos de URL HTTPS / SSH do GitHub, GitLab, Codeberg e Gitea são suportados.
Correspondência de elegibilidade
Strings de elegibilidade são regras em linguagem natural como:
"Must be an open-source project"→ verifica se há uma licença aprovada pela OSI"Must have at least 100 GitHub stars"→ verificastars >= 100"Project must be at least 3 months old"→ verifica a idade do repositório"Must be actively maintained"→ verifica commits recentes
A correspondência é heurística — ela analisa limites e palavras-chave do texto da regra. Casos limítrofes são marcados como ? (desconhecido) em vez de uma falha definitiva.
Exemplos
# Verifica todos os programas do seu repositório atual
ossperks check
# Verifica um repositório específico sem estar dentro dele
ossperks check --repo vercel/next.js
# Verifica um projeto GitLab
ossperks check --repo group/project --provider gitlab
# Verifica apenas um programa específico
ossperks check --program vercel
# Escolher interativamente quais programas verificar (interface de terminal)
ossperks check --interactive
# Saída JSON para scripts
ossperks check --jsonSaída
✅ my-project — MIT · 412 estrelas · último push há 3 dias
Elegibilidade em 48 programas — 12 elegíveis, 8 precisam de revisão, 28 não elegíveis
✅ Vercel for Open Source Provavelmente elegível — projeto de código aberto
✅ Netlify Open Source Plan Provavelmente elegível — projeto de código aberto
⚠️ GitHub Copilot Pro for Open Source Maintainers Precisa de revisão — revisão manual necessária
❌ DigitalOcean Open Source Credits Provavelmente não elegível — estrelas insuficientes no GitHubStatus:
- ✅ Provavelmente elegível — todas as regras de elegibilidade analisadas foram atendidas
- ⚠️ Precisa de revisão — pelo menos uma regra não pôde ser avaliada automaticamente
- ❌ Provavelmente não elegível — uma ou mais regras claramente não foram atendidas
Sempre verifique na página oficial do programa antes de se candidatar.