Riferimento agli strumenti a linea di comando Yak

Lo strumento a linea di comando Yak è incluso in Rhino 7 WIP. In Windows, lo strumento si trova in "C:\Program Files\Rhino 8System\yak.exe". Su macOS esiste un comodo script in "/Applications/Rhino 8.app/Contents/Resources/bin/yak".

Comandi

Build

  • Since 0.2: Command added
  • Since 0.4: Supports multiple .gha files, .rhp files or anything else for that matter
  • Since 0.9: Appends distribution tag to filename and expands $version placeholder
  • Since 0.10.1: Adds --platform argument

Quando viene eseguito in una cartella contenente un file manifest.yaml valido, crea un pacchetto contenente tutti i file della cartella.

Usage: yak build [options]

Options:
    --platform PLATFORM  The platform where the package will run ('win', 'mac' or 'any')
    -h, --help           Get help (equivalent to `yak help build`)
Nota
Un tag di distribuzione (ad esempiorh7-win) viene aggiunto al nome del file del pacchetto creato. Il tag viene determinato ispezionando il contenuto del pacchetto durante la creazione. L’argomento --platform=any può essere usato se l’autore vuole pubblicare una distribuzione multipiattaforma, ad esempio code>rh7-any. Attualmente è possibile ispezionare solo i file .rhp e .gha. Se un pacchetto non contiene nessuno di questi elementi, avrà un tag di distribuzione any-any.

Install

  • Since 0.1: Command added
  • Since 0.13.0: Supports installing local .yak files

Installa un pacchetto (facoltativamente con una versione specifica).

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

Dove<package> è il nome di un pacchetto o il percorso di un file .yak locale.

List

Since 0.2

Elenca i pacchetti installati sulla macchina.

yak list

Login

  • Since 0.2: Command added
  • Since 0.10: User registered during login

Autentica con Rhino Accounts e memorizza un token di accesso OAuth2 limitato nel tempo, in modo che l’utente possa usare i comandi che richiedono l’autenticazione.

Usage: yak login [options]

Options:
    --ci              Generate a non-expiring API key and display it
    -s, --source URL Posizione del repository del pacchetto [default: https://yak.rhino3d.com/].
    -h, --help        Get help (equivalent to `yak help login`)

Su Windows, il token è memorizzato in %appdata%\McNeel\yak.yml. Su macOS, è memorizzato in ~/.mcneel/yak.yml.

Durante il primo accesso, l’utente viene registrato sul server.

Nota
In un ambiente di compilazione automatizzato, ad esempio una macchina di compilazione, GitHub Actions, ecc. - lo strumento CLI yak può leggere il token di accesso dalla variabile d’ambiente YAK_TOKEN. Utilizzare il flag --ci per effettuare il login e creare un token a questo scopo.

Push

Since 0.1

Invia un pacchetto al server.

yak push [--source=URL] <filename>
Nota
Richiede autenticazione.
  • Since 0.1: Command added
  • Since 0.5: Adds --all and --prerelease flags

Cerca sul server i pacchetti che corrispondono a query.

Usage: yak search [options] <query>

  Opzioni:
    --prerelease      Display prerelease package versions
    -a, --all         Display all package versions
    -s, --source URL  Package repository location
    -h, --help        Get help (equivalent to `yak help search`)

Spec

  • Since 0.2: Command added
  • Since 0.4: Adds support for inspecting .rhp files (RhinoCommon only)

Crea un file manifest.yml strutturale, basato sul contenuto della cartella corrente. Quando viene eseguito in una directory contenente un assieme Grasshopper (.gha) o un plug-in RhinoCommon, il file (.rhp) verrà ispezionato e utilizzato per pre-popolare il file manifest.yml.

yak spec

Uninstall

Since 0.1

Disinstalla un pacchetto.

yak uninstall <package>

Yank

Since 0.6

Rimuove una versione dall’indice del pacchetto.

yak yank <package> <version>
Nota
Richiede autenticazione.

Le versioni eliminate non appaiono nelle ricerche, ma possono essere installate se si conosce la versione esatta del pacchetto. Sono nascosti a tutti gli effetti.

Non è possibile inviare una versione del pacchetto che è stata eliminata. In questo caso, è sufficiente modificare il numero di versione del proprio pacchetto e ripetere l’operazione.

Se tutte le versioni di un pacchetto vengono rimosse, esso non apparirà più nell’indice dei pacchetti.

Pericolo

Eliminazione di un pacchetto dal server McNeel

Per cancellare un pacchetto dal server pubblico, inviare un'e-mail a support@mcneel.com. Una volta che il pacchetto è stato cancellato, il nome non può più essere utilizzato.

Unyank

Funziona come il comando yank, ma al contrario!

Owner

Since 0.10

Aggiunge, rimuove o elenca i proprietari di un pacchetto. I proprietari di un pacchetto possono inviare nuove versioni del pacchetto e eliminare o annullare l’eliminazione delle versioni esistenti.

Usage:
    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  Package repository location [default: https://yak.rhino3d.com/].

Tenere presente che i nuovi proprietari possono fare tutto ciò che può fare il proprietario originale.

I nuovi proprietari devono essere registrati sul server prima di poter essere aggiunti a un pacchetto. Possono farlo eseguendo il comando login.

Download

yak CLI è disponibile come eseguibile indipendente per l’uso in ambienti in cui Rhino non è installato, ad esempio su macchine di compilazione automatica.