Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/mystenlabs/sui/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through installing and configuring the necessary tools to start developing on Sui.

​
Prerequisites

Before you begin, ensure you have:
  • A modern operating system (macOS, Linux, or Windows with WSL2)
  • At least 8GB of RAM
  • 10GB of free disk space

​
Install Sui CLI

The Sui CLI is the primary tool for interacting with the Sui network and developing Move packages.
1
Install Rust
2
Sui requires Rust to be installed. Install it using rustup:
3
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
4
After installation, configure your current shell:
5
source $HOME/.cargo/env
6
Install Sui from source
7
Clone the Sui repository and install the CLI:
8
cargo install --locked --git https://github.com/MystenLabs/sui.git --branch mainnet sui
9
This will install the sui binary to ~/.cargo/bin/.
10
Verify installation
11
Check that Sui is installed correctly:
12
sui --version
13
You should see output similar to:
14
sui 1.18.0-a9f87b9cc
15
Initialize Sui configuration
16
Run the client to initialize your configuration:
17
sui client
18
This creates a configuration file at ~/.sui/sui_config/client.yaml and generates a new keypair.

​
Configure Network Connection

Sui supports multiple networks: localnet, devnet, testnet, and mainnet.

​
View active environment

sui client active-env

​
Switch to testnet

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

​
Get testnet tokens

Request test SUI tokens from the faucet: 
sui client faucet

​
Check your address and balance

# View your address
sui client active-address

# Check balance
sui client gas

​
Install Development Tools

​
VS Code Extension

For the best Move development experience, install the Move Analyzer extension:
  1. Open VS Code
  2. Go to Extensions (Cmd/Ctrl + Shift + X)
  3. Search for “Move” and install the Move Analyzer extension

​
Git

Ensure Git is installed for version control: 
git --version
If not installed, download from git-scm.com.

​
Set Up Local Network (Optional)

For local development and testing, you can run a local Sui network:
1
Start local network
2
SUI_RUN_FULLNODE_MODE=1 sui start
3
This starts a local Sui network with a fullnode and faucet.
4
Switch to localnet
5
In a new terminal:
6
sui client new-env --alias localnet --rpc http://127.0.0.1:9000
sui client switch --env localnet
7
Request local tokens
8
sui client faucet

​
Verify Your Setup

Create a simple test to verify everything works: 
# Check client is working
sui client active-address

# View available commands
sui --help

# Check Move compiler
sui move --help

​
Next Steps

Now that your environment is set up:

​
Troubleshooting

​
Rust toolchain issues

If you encounter Rust version issues: 
rustup update stable

​
Network connectivity

If you can’t connect to a network, verify the RPC endpoint: 
sui client envs

​
Permission errors

On Linux/macOS, you may need to add Cargo’s bin directory to your PATH: 
export PATH="$HOME/.cargo/bin:$PATH"
Add this line to your ~/.bashrc or ~/.zshrc to make it permanent.

Build docs developers (and LLMs) love

Get started for freeTalk to us