Yak CLI Reference

A reference for the Yak command line tool.

Build

Since 0.2

When run in a directory containing a valid manifest.yaml file, creates a package containing all files in the directory.

yak build
Note: Currently this only works if there is exactly one .gha file in the directory.

Install

Since 0.1

Installs a package (optionally with a specific version).

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

List

Since 0.2

Lists the packages installed on the machine.

yak list

Login

Since 0.2

Authenticates with Rhino Accounts and stores a time-limited OAuth2 access token so that the user can use commands which require authentication.

yak login

On macOS, credentials are stored in ~/.mcneel/yak.yml. On Windows, they are stored in %appdata%\McNeel\yak.yml.

Push

Since 0.1

Pushes a package to the server.

yak push [--source=URL] <filename>
Note: Requires authentication.

Since 0.1

Searches the server for packages which match query.

yak search [--source=URL] <query>

Spec

Since 0.2

When run in a directory containing a *.gha file, creates a manifest.yml file populated with metadata from the Grasshopper plug-in.

yak spec
Note: Currently this only works if there is exactly one .gha file in the directory.
Note: This command is only useful if you've implemented GH_AssemblyInfo in the Grasshopper plug-in.

Uninstall

Since 0.1

Uninstalls a package.

yak uninstall <package>
Note: This doesn't actually remove the package from the machine, it just removes the manifest.txt file that tells Rhino which version to load.