Yarn is a package manager for your code and lets developers
share code with others. Code is shared via a package that contains all shared code and a
package.json file describing the package. The link takes you to
the Yarn install page, where you first select what operating system you want to
install on. Your selection changes the page's content to give install instructions for that
OS and links to the needed downloads.
Open a shell. The rest of this table's Actions take place in
A terminal on Macs; see
To launch a bash shell at a specific folder on Windows 10:
Navigate to that folder in File Explorer.
Click the address bar while in that folder.
Type bash in the address bar and press Enter
If you already have a ~/agoric-sdk directory, update it:
cd agoric-sdk git checkout master git pull
In the next step, if you don't have a copy of our agoric-sdk directory, you'll get one. This is in case you already have one and might need to update it.
If you don't have an ~/agoric-sdk directory with Agoric's SDK content in it,
git clone https://github.com/Agoric/agoric-sdk
Get the latest Agoric SDK from the Agoric GitHub
repository. It goes into the
agoric-sdk sub-directory of your home directory.
If the agoric-sdk sub-directory doesn't already exist,
this operation creates it.
Change to the agoric-sdk subdirectory in your home
Install NPM dependencies.
Build sources that need compiling. Note:build is not a standard yarn command,
but one installed with the Agoric SDK.
Install the Agoric CLI by: yarn link-cli
<agoric script location>
Select a location for the Agoric wrapper script. For example,
yarn link-cli /usr/local/bin/agoric (or if that fails
with permission problems, sudo yarn link-cli /usr/local/bin/agoric)
This creates a shell script that, when run, accesses the SDK's Agoric CLI. We
strongly recommend putting it at /usr/local/bin/agoric, but its specific
location and name is up to you.