Référence pour l’outil de ligne de commande Yak

par Will Pearson (Dernière mise à jour : lundi 28 July 2025)

L’outil de ligne de commande Yak est inclus dans Rhino 7 WIP. Sous Windows, l’outil se trouve sur "C:\Program Files\Rhino 8\System\yak.exe". Pour Mac, il existe un script pratique sur "/Applications/Rhino 8.app/Contents/Resources/bin/yak".

Commandes

Build

  • Depuis la version 0.2 : Commande ajoutée
  • Depuis la version 0.4 : Prise en charge de plusieurs fichiers .gha, .rhp ou autres
  • Depuis la version 0.9 : Ajout de l’étiquette de distribution au nom de fichier et extension de l’espace réservé $version.
  • Depuis 0.10.1 : Ajout de l’argument --platform.

Lorsque cette commande est exécutée dans un répertoire contenant un fichier manifest.yaml valide, elle crée un paquet contenant tous les fichiers du répertoire.

Utilisation : yak build [options]

Options :
    --platform PLATFORM  La plateforme sur laquelle le paquet sera exécuté ('win', 'mac' ou 'any')
    -h, --help           Obtenir de l’aide (équivalent de `yak help build`)
Remarque
Une étiquette de distribution (par exemple rh7-win) est ajoutée au nom de fichier du paquet créé. L’étiquette est déterminée au moment de la création du paquet après inspection de son contenu. Si l’auteur souhaite réaliser une distribution multiplateforme, il peut utiliser l’argument --platform=any, par exemple rh7-any. À l’heure actuelle, seuls les fichiers .rhp et .gha peuvent être inspectés. Si un paquet n’en contient aucun, l’étiquette de distribution associée sera any-any.

Install

  • Depuis la version 0.1 : Commande ajoutée
  • Depuis 0.13.0 : Prise en charge de l’installation de fichiers .yak locaux

Cette commande installe un paquet (éventuellement avec une version spécifique).

Utilisation :
    yak install [--source=URL] <package> [<version>]
    yak install <package>

Dans cet exemple <package> est soit le nom d’un paquet soit le chemin vers un fichier .yak local.

List

Depuis la version 0.2 :

Liste les paquets installés sur la machine

yak list

Login

  • Depuis la version 0.2 : Commande ajoutée
  • Depuis la version 0.10 : Enregistrement de l’utilisateur lors de la connexion

Cette commande authentifie l’utilisateur avec Rhino Accounts et enregistre un jeton d’accès OAuth2 d’une durée de validité limitée afin que l’utilisateur puisse accéder aux commandes requérant une authentification.

Utilisation : yak login [options]

Options :
    --ci              Génère une clé API qui n’expire pas et l’affiche
    -s, --source URL  Emplacement du répertoire du paquet [par défaut : https://yak.rhino3d.com/].
    -h, --help        Obtenir de l’aide (équivalent de `yak help login`)

Sous Windows, le jeton est stocké dans %appdata%\McNeel\yak.yml ; sous macOS, dans ~/.mcneel/yak.yml.

Lors de la première connexion, l’utilisateur est enregistré sur le serveur.

Remarque
Dans un environnement de compilation automatisé (par exemple une machine de compilation, GitHub Actions, etc.) l’outil CLI yak peut lire le jeton d’accès depuis la variable d’environnement YAK_TOKEN. Utilisez l’option --ci pour vous connecter et générer un jeton à cet effet !

Push

Depuis la version 0.1 :

Envoie un paquet sur le serveur.

yak push [--source=URL] <filename>
Remarque
Cette commande requiert une authentification.
  • Depuis la version 0.1 : Commande ajoutée
  • _Depuis la version 0.5 : Ajout des options --all et --prerelease.

Cette commande permet de rechercher sur le serveur les paquets qui correspondent à query.

Utilisation : yak search [options] <query>

  Options :
    --prerelease      Affiche les versions préliminaires du paquet
    -a, --all         Affiche toutes les versions su paquet
    -s, --source URL  Emplacement du répertoire du paquet
    -h, --help        Obtenir de l’aide (équivalent de `yak help search`)

Spec

  • Depuis la version 0.2 : Commande ajoutée
  • Depuis la version 0.4 : Ajout de la prise en charge de l’inspection des fichiers .rhp (RhinoCommon uniquement)

Cette commande crée un fichier manifest.yml squelette à partir du contenu du répertoire en cours. Lorsqu’elle est exécutée dans un répertoire contenant un ensemble Grasshopper (.gha) ou un module RhinoCommon (.rhp), le fichier sera inspecté et utilisé pour préremplir le fichier manifest.yml.

yak spec

Uninstall

Depuis la version 0.1

Cette commande désinstalle un paquet.

yak uninstall <package>

Yank

Depuis la version 0.6

Cette commande supprime une version de l’indice du paquet.

yak yank <package> <version>
Remarque
Cette commande requiert une authentification.

Les versions occultées n’apparaissent pas dans les recherches ; elles peuvent néanmoins être installées si la version exacte du paquet est connue. Dans tous les cas, elles sont cachées.

Il n’est pas possible d’envoyer de nouveau une version de paquet qui a été occultée. Si vous vous trouvez dans cette situation, vous devrez alors modifier le numéro de version de votre paquet et recommencer.

Si toutes les versions d’un paquet sont supprimées, celui-ci n’apparaîtra plus dans l’indice des paquets.

Danger

Suppression d’un paquet du serveur de McNeel

Si vous devez absolument supprimer votre paquet du serveur public, envoyez un e-mail à support@mcneel.com. Une fois qu’un paquet a été supprimé, le nom qu’il portait ne peut plus être utilisé.

Unyank

Fonctionne de la même manière que la commande « yank », mais en sens inverse !

Owner

Depuis la version 0.10

Ajout, suppression ou énumération des propriétaires d’un paquet. Les propriétaires de paquets peuvent envoyer de nouvelles versions du paquet et annuler l’occultation des versions existantes.

Utilisation :
    yak owner add [--source=URL] <package> <email>
    yak owner remove [--source=URL] <package> <email>
    yak owner list [--source=URL] <package>
    
Options :
    -h, --help
    -s, --source URL  Emplacement du répertoire du paquet [par défaut : https://yak.rhino3d.com/].

Les nouveaux propriétaires peuvent faire tout ce que le propriétaire d’origine peut faire. Tenez-en compte !

Les nouveaux propriétaires doivent être enregistrés sur le serveur avant de pouvoir être ajoutés à un paquet. Pour cela, ils devront exécuter la commande login.

Téléchargements

Le CLI yak est disponible en tant qu’exécutable autonome pour une utilisation dans des environnements où Rhino n’est pas installé, comme sur des machines de compilation automatisées.