OSS Perks

ossperks CLI

直接在终端浏览开源软件福利计划并检查您的项目是否符合条件。

概述

ossperks 是一个零配置的命令行工具,让您可以:

  • 列出所有开源软件福利项目
  • 搜索按关键词、提供商或类别查找项目
  • 显示任何项目的完整详情(福利、资格要求、申请方式)
  • 检查您自己的代码仓库是否符合项目资格 — 自动从 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

命令别名

每个命令都有简短的别名以方便使用:

命令别名
listls
showinfo
searchfind, s
checkck
categoriescats

仓库检测工作原理

ossperks check 无需任何提示即可自动检测您的代码仓库:

  1. 从当前目录的 package.json 中读取 repository 字段
  2. 如果找不到,则回退到解析 .git/config 中的 remote.origin.url
  3. 调用 GitHub、GitLab、Codeberg 或 Gitea 公共 API 获取实时数据(星标数、许可证、活跃度等)
  4. 将这些数据与每个项目的资格规则进行匹配

公共仓库无需 API 令牌。

遥测数据

本命令行工具会收集匿名使用统计信息(命令名称、版本、操作系统)以帮助改进工具。不会收集任何仓库名称、用户名或个人信息。

如需退出,请设置以下任一环境变量:

export DO_NOT_TRACK=1

# 或者

export DISABLE_TELEMETRY=1

更新通知

当 npm 上有更新版本可用时,CLI 会在命令输出后显示一行提示。该检查会在本地缓存 1 小时,并且永远不会阻塞命令执行。

后续步骤

  • list — 浏览所有程序
  • show — 查看程序详情
  • check — 自动检查您的 仓库资格
  • search — 按关键词搜索程序
  • categories — 按类别浏览 (在 TTY 中交互式操作)

On this page