Installation

Prerequisites

Before installing Sui, ensure you have the following:

Operating System

Linux (Ubuntu 20.04+, Debian 11+, or equivalent)
macOS (12+, both Intel and Apple Silicon)
Windows (via WSL2)

Development Tools

Rust toolchain (1.75.0 or later)
Git for version control
Build tools (gcc, cmake, libssl-dev)

Recommended

VS Code with Move extension
16GB+ RAM for building from source
20GB+ disk space for dependencies and builds

Install Rust

Sui is written in Rust, so you’ll need the Rust toolchain:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source "$HOME/.cargo/env"

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source "$HOME/.cargo/env"

Verify installation:

rustc --version
cargo --version

Sui requires Rust 1.75.0 or later. Update if needed: rustup update stable

Install System Dependencies

Ubuntu/Debian
macOS
Windows (WSL2)

sudo apt-get update
sudo apt-get install -y \
  curl \
  git \
  build-essential \
  libssl-dev \
  pkg-config \
  cmake \
  clang

# Install Homebrew if not already installed
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install dependencies
brew install curl git cmake

# Inside WSL2 Ubuntu
sudo apt-get update
sudo apt-get install -y \
  curl \
  git \
  build-essential \
  libssl-dev \
  pkg-config \
  cmake \
  clang

Install Sui from Binaries

The fastest way to get started:

Download from GitHub Releases

Visit the Sui releases page and download the appropriate binary for your platform.

Linux
macOS

# Example for Linux x86_64
wget https://github.com/MystenLabs/sui/releases/download/mainnet-v1.68.0/sui-mainnet-v1.68.0-ubuntu-x86_64.tgz
tar -xzf sui-mainnet-v1.68.0-ubuntu-x86_64.tgz
sudo mv sui /usr/local/bin/

# Example for macOS Intel
wget https://github.com/MystenLabs/sui/releases/download/mainnet-v1.68.0/sui-mainnet-v1.68.0-macos-x86_64.tgz
tar -xzf sui-mainnet-v1.68.0-macos-x86_64.tgz
sudo mv sui /usr/local/bin/

# For Apple Silicon
wget https://github.com/MystenLabs/sui/releases/download/mainnet-v1.68.0/sui-mainnet-v1.68.0-macos-arm64.tgz
tar -xzf sui-mainnet-v1.68.0-macos-arm64.tgz
sudo mv sui /usr/local/bin/

Verify Installation

sui --version

Expected output:

sui 1.68.0

Install Sui from Source

For the latest features or development:

Clone the Repository

git clone https://github.com/MystenLabs/sui.git
cd sui

For a specific version: git checkout mainnet-v1.68.0

Build the Sui Binary

cargo install --locked --git https://github.com/MystenLabs/sui.git --branch main sui

Or build from local checkout:

cargo build --release --bin sui
sudo mv target/release/sui /usr/local/bin/

Building from source can take 15-30 minutes and requires significant RAM.

Verify Installation

sui --version

Install Using Cargo

Install directly from crates.io:

cargo install --locked --git https://github.com/MystenLabs/sui.git --branch main sui

Add --branch testnet or --branch devnet to install network-specific versions.

Alternative Installation Methods

Homebrew (macOS)

brew install sui

Chocolatey (Windows)

choco install sui

These may not always have the latest version. Check with sui --version.

Initial Configuration

After installation, set up your Sui environment:

Initialize Sui Configuration

sui client

On first run, this will:

Create ~/.sui/sui_config/ directory
Generate a new keypair
Create a client configuration file
Set up environment for Sui devnet

Check Active Address

sui client active-address

Output:

0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef

Get Test Tokens (Devnet)

sui client faucet

This will request test SUI tokens from the devnet faucet.

Check Balance

sui client balance

Expected output:

╭────────────────────────────────────────╮
│ Balance                                │
├────────────────────────────────────────┤
│ SUI: 1.0 SUI                           │
╰────────────────────────────────────────╯

Network Configuration

Configure connections to different Sui networks:

Devnet
Testnet
Mainnet
Local Network

sui client new-env \
  --alias devnet \
  --rpc https://fullnode.devnet.sui.io:443

sui client switch --env devnet

sui client new-env \
  --alias testnet \
  --rpc https://fullnode.testnet.sui.io:443

sui client switch --env testnet

sui client new-env \
  --alias mainnet \
  --rpc https://fullnode.mainnet.sui.io:443

sui client switch --env mainnet

sui client new-env \
  --alias local \
  --rpc http://127.0.0.1:9000

sui client switch --env local

View configured environments:

sui client envs

Install IDE Support

VS Code

Install the Move language extension:

Install Extension

Search for “move-analyzer” in VS Code extensions marketplace and install.

Configure Move Analyzer

The extension uses the Move analyzer binary. Install it:

cargo install --git https://github.com/move-language/move move-analyzer

Enable in VS Code

Create .vscode/settings.json in your project:

{
  "move-analyzer.server.path": "~/.cargo/bin/move-analyzer"
}

Other IDEs

Emacs: move-mode
Vim/Neovim: Use LSP client with move-analyzer

Verify Complete Installation

Run a comprehensive check:

# Check Sui version
sui --version

# Check available commands
sui --help

# Verify network connection
sui client objects

# Check gas balance
sui client gas

If all commands execute successfully, you’re ready to start developing!

Troubleshooting

Command not found: sui

Solution: Add Cargo bin directory to PATH:

echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

Build fails with linker errors

Solution: Install required development libraries:

Ubuntu/Debian

sudo apt-get install -y build-essential libssl-dev pkg-config

macOS

xcode-select --install

Out of memory during build

Solution:

Close other applications
Use cargo build instead of cargo install (slower but less memory)
Add swap space (Linux)
Use pre-built binaries instead

Faucet request fails

Solution:

Check network connection: sui client envs
Try web faucet: https://faucet.devnet.sui.io/
Switch to a different network: sui client switch --env testnet

SSL/TLS errors

Solution: Update certificates:

Ubuntu/Debian

sudo apt-get install ca-certificates
sudo update-ca-certificates

macOS

brew install openssl

Update Sui

To update to the latest version:

From Source
Using Cargo
Homebrew

cd sui
git pull
cargo install --locked --path crates/sui

cargo install --locked --git https://github.com/MystenLabs/sui.git --branch main sui --force

brew upgrade sui

Next Steps

Quickstart Tutorial

Build and deploy your first Move package

Your First Move Package

Learn Move programming basics

CLI Reference

Explore all CLI commands

Setup Dev Environment

Configure your complete dev environment

Introduction

Quick Start

Installation

Prerequisites

Install Rust

Install System Dependencies

Install Sui from Binaries

Install Sui from Source

Install Using Cargo

Alternative Installation Methods

Homebrew (macOS)

Chocolatey (Windows)

Initial Configuration

Network Configuration

Install IDE Support

VS Code

Other IDEs

Verify Complete Installation

Troubleshooting

Update Sui

Next Steps

Quickstart Tutorial

Your First Move Package

CLI Reference

Setup Dev Environment

​Prerequisites

​Install Rust

​Install System Dependencies

​Install Sui from Binaries

​Install Sui from Source

​Install Using Cargo

​Alternative Installation Methods

​Homebrew (macOS)

​Chocolatey (Windows)

​Initial Configuration

​Network Configuration

​Install IDE Support

​VS Code

​Other IDEs

​Verify Complete Installation

​Troubleshooting

​Update Sui

​Next Steps

Quickstart Tutorial

Your First Move Package

CLI Reference

Setup Dev Environment

Prerequisites

Install Rust

Install System Dependencies

Install Sui from Binaries

Install Sui from Source

Install Using Cargo

Alternative Installation Methods

Homebrew (macOS)

Chocolatey (Windows)

Initial Configuration

Network Configuration

Install IDE Support

VS Code

Other IDEs

Verify Complete Installation

Troubleshooting

Update Sui

Next Steps