ossperks CLI
ターミナルから直接、OSS特典プログラムを閲覧し、プロジェクトが対象かどうかを確認できます。
概要
ossperksは、設定不要のコマンドラインツールで、次のことができます:
- 一覧表示 すべてのOSS特典プログラムを一箇所に表示
- 検索 キーワード、プロバイダー、カテゴリーでプログラムを検索
- 詳細表示 任意のプログラムの完全な詳細(特典、資格要件、申請方法)を表示
- チェック 自分のリポジトリがプログラムの資格を満たしているかを自動的に確認 — GitHubまたはGitLab APIからライブデータを取得して判定
- オープン ターミナルから直接ossperksウェブサイトを開く
インストール
npm install -g ossperksまたはインストールせずに実行:
npx ossperksクイックスタート
# すべてのプログラムを一覧表示
ossperks list
# 現在のプロジェクトを確認
cd /path/to/your/repo
ossperks check
# キーワードで検索
ossperks search "hosting"
# プログラムの詳細を表示
ossperks show vercel
# ブラウザでossperks.comを開く
ossperks openコマンドのエイリアス
すべてのコマンドには便利な短縮エイリアスがあります:
| コマンド | エイリアス |
|---|---|
list | ls |
show | info |
search | find, s |
check | ck |
categories | cats |
リポジトリ検出の仕組み
ossperks checkは、プロンプトなしでリポジトリを自動検出します:
- 現在のディレクトリにある
package.jsonのrepositoryフィールドを読み取る .git/configからremote.origin.urlを解析してフォールバック- GitHub、GitLab、Codeberg、またはGitea公開APIを呼び出してライブデータ(スター数、ライセンス、アクティビティなど)を取得
- そのデータを各プログラムの資格要件ルールと照合
公開リポジトリにはAPIトークンは不要です。
テレメトリ
このCLIは、ツールの改善を目的として匿名の使用統計(コマンド名、バージョン、OS)を収集します。リポジトリ名、ユーザー名、個人情報は一切収集されません。
オプトアウトするには、次のいずれかの環境変数を設定してください:
export DO_NOT_TRACK=1
# または
export DISABLE_TELEMETRY=1更新通知
npmで新しいバージョンが利用可能な場合、CLIはコマンド出力の後に1行の通知を表示します。チェックは1時間ローカルにキャッシュされ、コマンドの実行をブロックすることはありません。
次のステップ
- list — すべてのプログラムを閲覧
- show — プログラムの詳細を表示
- check — リポジトリの適格性を自動チェック
- search — キーワードでプログラムを検索
- categories — カテゴリ別に閲覧（TTYでインタラクティブ表示）