ossperks
v0.3.2
Published
CLI to check if your project qualifies for OSS perk programs based on their guidelines.
Maintainers
Readme
Check if your project qualifies for open-source programs — across GitHub, GitLab, Codeberg, and Gitea.
Install
# Run without installing
npx ossperks
# Install globally
npm install -g ossperks
# or
pnpm add -g ossperksCommands
check
Check your project's eligibility across all supported OSS programs.
# Auto-detect repo from package.json or git config
ossperks check
# Specify a repo explicitly
ossperks check --repo vercel/next.js
# Check a GitLab, Codeberg, or Gitea repo
ossperks check --repo inkscape/inkscape --provider gitlab
ossperks check --repo forgejo/forgejo --provider codeberg
ossperks check --repo go-gitea/gitea --provider gitea
# Output results as JSON
ossperks check --repo vercel/next.js --jsonWhat gets checked automatically:
- License type (permissive, OSI-approved, copyleft)
- Star count thresholds
- Fork and private repo detection
- Tech stack requirements (e.g. Convex, Neon, Algolia packages in
package.json) - Hosting hints (e.g. presence of
vercel.json) - Project age
What requires manual review:
- Non-commercial use
- Community size
- Code of conduct
- Subjective or role-based criteria
list
List all available OSS programs.
ossperks list
# Filter by category
ossperks list --category devtools
# Output as JSON
ossperks list --jsonshow
Show details for a specific program by its slug.
ossperks show vercel
ossperks show sentry
ossperks show github-copilotsearch
Search programs by name, description, tags, or perks.
ossperks search "database"
ossperks search "ci cd"categories
List all available program categories.
ossperks categories
ossperks categories --jsonEnvironment Variables
Set these to avoid API rate limits when checking repos:
| Variable | Description |
| -------------- | ---------------------------- |
| GITHUB_TOKEN | GitHub personal access token |
| GITLAB_TOKEN | GitLab personal access token |
GITHUB_TOKEN=ghp_... ossperks check --repo your-org/your-repoDevelopment
See the CONTRIBUTING.md for development setup and commands.
