CLI ossperks
Navegue pelos programas de benefícios OSS e verifique se seu projeto se qualifica — direto do terminal.
Visão Geral
ossperks é uma ferramenta de linha de comando sem configuração que permite:
- Listar todos os programas de benefícios OSS em um só lugar
- Pesquisar programas por palavra-chave, provedor ou categoria
- Exibir detalhes completos de qualquer programa (benefícios, elegibilidade, como se inscrever)
- Verificar se o seu próprio repositório se qualifica para programas — automaticamente, buscando dados em tempo real da API do GitHub ou GitLab
- Abrir o site ossperks diretamente do terminal
Instalação
npm install -g ossperksOu execute sem instalar:
npx ossperksInício Rápido
# Listar todos os programas
ossperks list
# Verificar seu projeto atual
cd /caminho/para/seu/repo
ossperks check
# Pesquisar por palavra-chave
ossperks search "hospedagem"
# Mostrar detalhes do programa
ossperks show vercel
# Abrir ossperks.com no seu navegador
ossperks openAtalhos de comandos
Cada comando possui atalhos curtos para conveniência:
| Comando | Atalho(s) |
|---|---|
list | ls |
show | info |
search | find, s |
check | ck |
categories | cats |
Como funciona a detecção de repositório
ossperks check detecta automaticamente seu repositório sem nenhuma solicitação:
- Lê o campo
repositorydopackage.jsonno diretório atual - Retorna para analisar
remote.origin.urldo.git/config - Chama a API pública do GitHub, GitLab, Codeberg ou Gitea para buscar dados em tempo real (estrelas, licença, atividade, etc.)
- Compara esses dados com as regras de elegibilidade de cada programa
Nenhum token de API é necessário para repositórios públicos.
Telemetria
A CLI coleta estatísticas de uso anônimas (nome do comando, versão, sistema operacional) para ajudar a melhorar a ferramenta. Nenhum nome de repositório, nome de usuário ou informação pessoal é coletado.
Para desativar, defina uma destas variáveis de ambiente:
export DO_NOT_TRACK=1
# ou
export DISABLE_TELEMETRY=1Notificações de atualização
Quando uma versão mais recente está disponível no npm, a CLI exibe um aviso de uma linha após a saída do comando. A verificação é armazenada em cache localmente por 1 hora e nunca bloqueia a execução do comando.
Próximos passos
- list — navegue por todos os programas
- show — visualize detalhes do programa
- check — verifique automaticamente a elegibilidade do seu repositório
- search — encontre programas por palavra-chave
- categories — navegue por categoria (interativo em um TTY)