Befehlszeilenwerkzeug-Referenz in Yak

von Will Pearson (Zuletzt aktualisiert: Mittwoch, 13. August 2025)

Das Yak-Befehlszeilenwerkzeug ist in Rhino 7 WIP enthalten. Auf Windows finden Sie das Tool unter "C:\Programme\Rhino 8\System\yak.exe". Auf dem Mac gibt es das Convenience-Script auf "/Applications/Rhino 8.app/Contents/Resources/bin/yak".

Befehle

Erstellen

  • Seit 0.2: Befehl hinzugefügt
  • Seit 0.4: Unterstützt mehrere .gha-Dateien, .rhp-Dateien oder andere
  • Seit 0.9: Hängt den Distribution-Tag an den Dateinamen an und erweitert den Platzhalter $version
  • Seit 0.10.1: Das Argument --platform wird hinzugefügt

Wenn es in einem Verzeichnis ausgeführt wird, das eine gültige Datei “manifest.yaml” enthält, wird ein Paket erstellt, das alle Dateien in diesem Verzeichnis enthält.

Verwendung: yak build [Optionen]

Optionen:
    --platform PLATFORM Die Plattform, auf der das Paket laufen soll ('win', 'mac' oder 'any')
    -h, --help           Hilfe erhalten (entspricht `yak help build`)
Hinweis
Ein Distribution Tag (z.B.rh7-win) wird an den Dateinamen des erstellten Pakets angehängt. Die Kennzeichnung wird während der Erstellung durch die Überprüfung des Inhalts des Pakets bestimmt. Das Argument --platform=any kann verwendet werden, wenn der Autor eine plattformübergreifende Distribution veröffentlichen möchte, z.B. rh7-any. Derzeit können nur .rhp- und .gha-Dateien eingesehen werden. Wenn ein Paket keines dieser Elemente enthält, wird es mit dem Distribution Tag any-any versehen.

Installation

  • Seit 0.1: Befehl hinzugefügt
  • Seit 0.13.0: Unterstützt die Installation von lokalen .yak-Dateien

Installiert ein Paket (optional mit einer bestimmten Version).

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

Wobei <package> entweder der Name eines Pakets oder der Pfad zu einer lokalen .yak-Datei ist.

Liste

Seit 0.2

Listet die auf dem Rechner installierten Pakete auf.

yak list

Log-in

  • Seit 0.2: Befehl hinzugefügt
  • Seit 0.10: Bei der Anmeldung registrierter Benutzer

Authentifiziert sich mit Rhino-Konten und speichert ein zeitlich begrenztes OAuth2-Zugangs-Token, damit der Benutzer Befehle verwenden kann, die eine Authentifizierung erfordern.

Usage: yak login [options]

Optionen:
    --ci              Erzeugt einen nicht ablaufenden API-Schlüssel und zeigt hn an
    -s, --source URL  Speicherort des Paket-Repositorys [Standard: https://yak.rhino3d.com/].
    -h, --help        Hilfe erhalten (entspricht `yak help login`)

Auf Windows wird das Token in %appdata%\McNeel\yak.yml gespeichert. Auf macOS wird sie in ~/.mcneel/yak.yml gespeichert.

Bei der ersten Anmeldung wird der Benutzer auf dem Server registriert.

Hinweis
In einer automatisierten Build-Umgebung - z.B. einer Build-Maschine, GitHub Actions, etc. - kann das CLI-Tool yak das Zugriffstoken aus der Umgebungsvariablen YAK_TOKEN lesen. Benutzen Sie das --ci-Flag, um sich anzumelden und ein Token für diesen Zweck zu erzeugen!

Verschieben

Seit 0.1

Verschiebt ein Paket auf den Server.

yak push [--source=URL] <filename>
Hinweis
Erfordert Authentifizierung.
  • Seit 0.1: Befehl hinzugefügt
  • Seit 0.5: Fügt die Flags --all und --prerelease hinzu

Durchsucht den Server nach Paketen, die query entsprechen.

Verwendung: yak search [options] <query>

  Optionen:
    --prerelease      Paketversionen der Vorabversion anzeigen
    -a, --all         Alle Paketversionen anzeigen
    -s, --source URL  Ort des Paket-Repositorys
    -h, --help        Hilfe erhalten (entspricht `yak help search`)

Spec

  • Seit 0.2: Befehl hinzugefügt
  • Seit 0.4: Fügt Unterstützung für die Inspektion von .rhp-Dateien hinzu (nur RhinoCommon)

Erzeugt eine Skelettdatei manifest.yml auf der Grundlage des Inhalts des aktuellen Verzeichnisses. Wenn sie in einem Verzeichnis ausgeführt wird, das eine Grasshopper-Baugruppe (.gha) oder ein RhinoCommon-Plugin (.rhp) enthält, wird die Datei inspiziert und zum Vorbefüllen der Datei manifest.yml verwendet.

yak spec

Deinstallieren

Seit 0.1

Deinstalliert ein Paket.

yak uninstall <package>

Yank

Seit 0.6

Entfernt eine Version aus dem Paketindex.

yak yank <package> <version>
Hinweis
Erfordert Authentifizierung.

Veraltete Versionen erscheinen nicht in der Suche, können aber trotzdem installiert werden, wenn die genaue Paketversion bekannt ist. Sie sind sozusagen versteckt.

Es ist nicht möglich, eine Paketversion, die zurückgezogen wurde, erneut zu veröffentlichen. Wenn Sie sich in dieser Situation befinden, ändern Sie einfach die Versionsnummer Ihres Pakets und führen Sie den Push-Vorgang erneut durch.

Wenn alle Versionen eines Pakets entfernt werden, wird es nicht mehr im Paketindex angezeigt.

Gefahr

Löschen eines Pakets vom McNeel-Server

Wenn Sie Ihr Paket unbedingt vom öffentlichen Server löschen müssen, senden Sie bitte eine E-Mail an support@mcneel.com. Sobald ein Paket gelöscht wurde, kann der Name nicht mehr verwendet werden.

Unyank

Funktioniert genauso wie der Befehl yank, aber umgekehrt!

Eigentümer

Seit 0.10

Fügt die Eigentümer eines Pakets hinzu, entfernt sie oder listet sie auf. Paketbesitzer können neue Versionen des Pakets veröffentlichen und bestehende Versionen veröffentlichen bzw. zurücknehmen.

Verwendung:
    yak owner add [--source=URL] <package> <email>
    yak owner remove [--source=URL] <package> <email>
    yak owner list [--source=URL] <package>
    
Optionen:
    -h, --help
    -s, --source URL  Speicherort des Paket-Repositorys [Standard: https://yak.rhino3d.com/].

Der neue Eigentümer kann alles tun, was der ursprüngliche Eigentümer tun kann. Bitte beachten Sie dies!

Neue Eigentümer müssen auf dem Server registriert werden, bevor sie zu einem Paket hinzugefügt werden können. Sie können dies selbst mit dem Befehl login tun.

Downloads

Die yak CLI ist als eigenständige ausführbare Datei für die Verwendung in Umgebungen verfügbar, in denen Rhino nicht installiert ist, wie z.B. auf automatischen Build-Maschinen.