OSS Perks

Interface CLI ossperks

Parcourez les programmes d'avantages OSS et vérifiez si votre projet est éligible — directement depuis le terminal.

Aperçu

ossperks est un outil en ligne de commande sans configuration qui vous permet de :

  • Lister tous les programmes d'avantages OSS en un seul endroit
  • Rechercher des programmes par mot-clé, fournisseur ou catégorie
  • Afficher tous les détails d'un programme (avantages, éligibilité, comment postuler)
  • Vérifier si votre propre dépôt est éligible aux programmes — automatiquement, en récupérant les données en direct depuis l'API GitHub ou GitLab
  • Ouvrir le site web ossperks directement depuis le terminal

Installation

npm install -g ossperks

Ou exécutez sans installer :

npx ossperks

Démarrage rapide


# Lister tous les programmes

ossperks list

# Vérifier votre projet actuel

cd /path/to/your/repo
ossperks check

# Rechercher par mot-clé

ossperks search "hosting"

# Afficher les détails du programme

ossperks show vercel

# Ouvrir ossperks.com dans votre navigateur

ossperks open

Alias de commandes

Chaque commande dispose d'alias courts pour plus de commodité :

CommandeAlias
listls
showinfo
searchfind, s
checkck
categoriescats

Fonctionnement de la détection de dépôt

ossperks check détecte automatiquement votre dépôt sans aucune invite :

  1. Lit le champ repository depuis package.json dans le répertoire actuel
  2. Se replie sur l'analyse de remote.origin.url depuis .git/config
  3. Appelle l'API publique de GitHub, GitLab, Codeberg ou Gitea pour récupérer les données en direct (étoiles, licence, activité, etc.)
  4. Compare ces données aux règles d'éligibilité de chaque programme

Aucun jeton d'API requis pour les dépôts publics.

Télémétrie

Le CLI collecte des statistiques d'utilisation anonymes (nom de commande, version, système d'exploitation) pour améliorer l'outil. Aucun nom de dépôt, nom d'utilisateur ou information personnelle n'est jamais collecté.

Pour refuser, définissez l'une de ces variables d'environnement :

export DO_NOT_TRACK=1

# ou

export DISABLE_TELEMETRY=1

Notifications de mise à jour

Lorsqu'une version plus récente est disponible sur npm, l'interface en ligne de commande affiche un avis d'une ligne après la sortie de la commande. La vérification est mise en cache localement pendant 1 heure et ne bloque jamais l'exécution de la commande.

Prochaines étapes

  • list — parcourir tous les programmes
  • show — voir les détails du programme
  • check — vérifier automatiquement l'éligibilité de votre dépôt
  • search — rechercher des programmes par mot-clé
  • categories — parcourir par catégorie (interactif dans un TTY)

On this page