OSS Perks

ossperks check

Автоматически проверьте, соответствует ли ваш репозиторий требованиям программ льгот для открытого ПО.

Использование

ossperks check [параметры]

Запустите эту команду из любого Git-репозитория. Для публичных репозиториев аргументы или токены не требуются.

Параметры

ФлагОписание
-p, --program <slug>Проверить только конкретную программу (например, --program vercel)
--jsonВывести данные в формате JSON
-h, --helpПоказать справку

Как это работает

ossperks check выполняется полностью автоматически:

ossperks check


Чтение package.json (поле repository)
      │  ← не найдено?

Чтение .git/config (remote.origin.url)


Определение провайдера (github.com / gitlab.com)

      ├─ GitHub → GET /repos/:owner/:repo
      └─ GitLab → GET /api/v4/projects/:id


RepoContext (звёзды, лицензия, возраст, активность...)


Сопоставление с правилами приемлемости для каждой программы


Вывод результатов

Определение репозитория

Инструмент считывает URL вашего репозитория из одного из двух мест по порядку:

  1. Поле repository в package.json
  2. Значение remote.origin.url в .git/config

Поддерживаются форматы URL HTTPS и SSH для GitHub и GitLab.

Проверка приемлемости

Условия приемлемости — это правила на естественном языке, например:

  • "Must be an open-source project" → проверяет наличие лицензии, одобренной OSI
  • "Must have at least 100 GitHub stars" → проверяет условие stars >= 100
  • "Project must be at least 3 months old" → проверяет возраст репозитория
  • "Must be actively maintained" → проверяет наличие недавних коммитов

Сопоставление основано на эвристике — алгоритм извлекает пороговые значения и ключевые слова из текста правила. Пограничные случаи помечаются как ? (неизвестно), а не как жёсткий отказ.

Примеры


# Проверить все программы для текущего репозитория

ossperks check

# Проверить только конкретную программу

ossperks check --program vercel

# Вывод в формате JSON для использования в скриптах

ossperks check --json

Результат

Проверка репозитория: github.com/acme/my-project
  Звёзды: 412  Лицензия: MIT  Возраст: 14 месяцев  Последний коммит: 3 дня назад

ПРОГРАММА            СООТВЕТСТВИЕ
vercel                ✔ вероятно
netlify               ✔ вероятно
github-sponsors       ? неизвестно (требуется ручная проверка)
aws-activate          ✗ маловероятно

Статусы:

  • ✔ вероятно — все проанализированные критерии соответствия выполнены
  • ? неизвестно — как минимум один критерий не может быть автоматически проверен
  • ✗ маловероятно — один или несколько критериев явно не соответствуют

Всегда проверяйте информацию на официальной странице программы перед подачей заявки.

On this page