ossperks CLI

Overview

ossperks is a zero-config command-line tool that lets you:

• List every OSS perk program in one place
• Search programs by keyword, provider, or category
• Show full details for any program (perks, eligibility, how to apply)
• Check whether your own repository qualifies for programs — automatically, by fetching live data from the GitHub or GitLab API
• Open the ossperks website directly from the terminal

Installation

npm install -g ossperks

Or run without installing:

npx ossperks

Quick start

# List all programs
ossperks list

# Check your current project
cd /path/to/your/repo
ossperks check

# Search by keyword
ossperks search "hosting"

# Show program details
ossperks show vercel

# Open ossperks.com in your browser
ossperks open

Command aliases

Every command has short aliases for convenience:

How repo detection works

ossperks check auto-detects your repository without any prompts:

1. Reads the repository field from package.json in the current directory
2. Falls back to parsing remote.origin.url from .git/config
3. Calls the GitHub, GitLab, Codeberg, or Gitea public API to fetch live data (stars, license, activity, etc.)
4. Matches that data against every program's eligibility rules

No API tokens required for public repositories.

Telemetry

The CLI collects anonymous usage statistics (command name, version, OS) to help improve the tool. No repository names, user names, or personal information is ever collected.

To opt out, set either of these environment variables:

export DO_NOT_TRACK=1
# or
export OSSPERKS_NO_TELEMETRY=1

Update notifications

When a newer version is available on npm, the CLI shows a one-line notice after command output. The check is cached locally for 1 hour and never blocks command execution.

Next steps

• list — browse all programs
• show — view program details
• check — auto-check your repo eligibility
• search — find programs by keyword
• categories — browse by category (interactive in a TTY)