OSS Perks

ossperks CLI

ターミナルから直接、OSS特典プログラムを閲覧し、プロジェクトが対象かどうかを確認できます。

概要

ossperksは設定不要のコマンドラインツールで、以下のことができます:

  • 一覧表示 すべてのOSS特典プログラムを一箇所で確認
  • 検索 キーワード、提供者、カテゴリーでプログラムを検索
  • 詳細表示 任意のプログラムの完全な詳細(特典、資格要件、申請方法)を表示
  • 確認 お使いのリポジトリがプログラムの対象かどうかを自動的に確認 — GitHubまたはGitLab APIからライブデータを取得

インストール

npm install -g ossperks

クイックスタート


# すべてのプログラムを一覧表示

ossperks list

# 現在のプロジェクトを確認

cd /path/to/your/repo
ossperks check

# キーワードで検索

ossperks search "hosting"

# 特定のプログラムを表示

ossperks show vercel

リポジトリ検出の仕組み

ossperks checkは、プロンプトなしで自動的にリポジトリを検出します:

  1. 現在のディレクトリのpackage.jsonからrepositoryフィールドを読み取り
  2. .git/configからremote.origin.urlを解析してフォールバック
  3. GitHub または GitLab の公開APIを呼び出してライブデータ(スター数、ライセンス、アクティビティなど)を取得
  4. そのデータを各プログラムの資格要件ルールと照合

公開リポジトリにはAPIトークンは不要です。

次のステップ

  • list — すべてのプログラムを閲覧
  • show — プログラムの詳細を表示
  • check — リポジトリの資格を自動確認
  • search — キーワードでプログラムを検索
  • categories — 利用可能なカテゴリーを一覧表示

On this page