Back to Sui

Install from Binaries

docs/content/guides/developer/getting-started/install-binaries.mdx

latest5.3 KB
Original Source
<ImportContent source="info-easy-install" mode="snippet" />

Each Sui release provides a set of binaries for several operating systems. You can download these binaries from GitHub and use them to install Sui.

<Tabs groupId="operating-systems"> <TabItem value="linux" label="Linux">
  1. Go to https://github.com/MystenLabs/sui.

  2. In the right pane, find the Releases section.

  3. Click the release tagged Latest to open the release's page.

  4. In the Assets section of the release, select the .tgz compressed file that corresponds to your operating system.

  5. Extract all files from the .tgz file into the preferred location on your system. These instructions assume you extract the files into a sui folder at the user root of your system for demonstration purposes. Replace references to this location in subsequent steps if you choose a different directory.

  6. Navigate to the expanded folder. You should have the following extracted files:

    <ImportContent source="lists/binaries-file-list.mdx" mode="snippet" />
  7. Add the folder containing the extracted files to your PATH variable. To do so, you can update your ~/.bashrc to include the location of the Sui binaries. If using the suggested location, you type export PATH=$PATH:~/sui and press Enter.

  8. Start a new terminal session or type source ~/.bashrc to load the new PATH value.

</TabItem> <TabItem value="mac" label="macOS">
  1. Go to https://github.com/MystenLabs/sui.

  2. In the right pane, find the Releases section.

  3. Click the release tagged Latest to open the release's page.

  4. In the Assets section of the release, select the .tgz compressed file that corresponds to your operating system.

  5. Extract all files from the .tgz file into the preferred location on your system. These instructions assume you extract the files into a sui folder at the user root of your system. Replace references to this location in subsequent steps if you choose a different directory.

  6. Navigate to the expanded folder. You should have the following extracted files:

    <ImportContent source="lists/binaries-file-list.mdx" mode="snippet" />
  7. Add the folder containing the extracted files to your PATH variable. To do so, you can update your ~/.zshrc or ~/.bashrc to include the location of the Sui binaries. If using the suggested location, you type export PATH=$PATH:~/sui and press Enter.

  8. Start a new console session or type source ~/.zshrc (or .bashrc) to load the new PATH value.

  9. If running the binaries for the first time, you might receive an error from MacOS that prevents the binaries from running. If you receive this error, close the dialog and type xattr -d com.apple.quarantine ~/sui/* in your console and press <kbd>Enter</kbd> (be sure to adjust the path if different).

</TabItem> <TabItem value="win" label="Windows">
  1. Go to https://github.com/MystenLabs/sui.

  2. In the right pane, find the Releases section.

  3. Click the release tagged Latest to open the release's page.

  4. In the Assets section of the release, select the .tgz compressed file that corresponds to your operating system.

  5. Extract all files from the .tgz file into the preferred location on your system. These instructions assume you extract the files into a sui folder at the root of your C drive. Replace references to this location in subsequent steps if you choose a different directory.

    :::info

    Windows does not natively support .tgz files, but you can use a free compressed file app like 7Zip to extract.

    :::

  6. Navigate to the expanded folder. You should have the following extracted files:

    <ImportContent source="lists/binaries-file-list.mdx" mode="snippet" />
  7. Add the folder containing the extracted files to your PATH variable. There are several ways to get to the setting depending on your version of Windows. One way that works on all versions of Windows is to type sysdm.cpl in a console to open the System Properties window. Under the Advanced tab, click the Environment Variables... button.

  8. In the Environment Variables window, select the Path variable and click the Edit... button.

  9. In the Edit environment variable window, click New and add the path to your expanded folder. Using the example path, this would be C:\sui.

  10. Click OK.

</TabItem> </Tabs>

Build binaries locally

You can download the Sui repo and build the binaries locally. The binaries are exported to the target/release directory.

sh
$ cargo build --profile release --bin sui

Include other packages as needed.

<ImportContent source="lists/binaries-file-list.mdx" mode="snippet" />

Upgrade from Cargo

If you previously installed the Sui binaries, you can update them to the most recent release with the same command you used to install them (changing testnet to the desired branch):

sh
$ cargo install --locked --git https://github.com/MystenLabs/sui.git --branch testnet sui --features tracing

:::info

The tracing feature enables Move test coverage and debugger support in the Sui CLI. These features are not available unless you enable tracing.

:::

Install sui-node for Ubuntu from AWS {#aws-sui-node}

<ImportContent source="install-sui-node.mdx" mode="snippet" />