Getting Started
Sui is the first internet-scale programmable blockchain platform. That might read like marketing speak, but as you peruse the documentation to understand the technology, you will discover that Sui addresses many of the problems that hold blockchains back from mass adoption.
Before you can get started developing on Sui, you need to understand the code repository and install its binaries.
Install Sui
Use one of the following commands for Homebrew (MacOS, Linux, or Windows Subsystem for Linux), Chocolatey (Windows), or suiup (a custom installer and version manager for Sui related tools) to install Sui.
- Homebrew
- Chocolatey
- suiup (experimental)
$ brew install sui
$ choco install sui
Find more versions of Sui for Windows on the Chocolatey community website.
$ suiup install sui@testnet
Find more information on installation and a quick start guide in the suiup repository: https://github.com/MystenLabs/suiup.
You can also install Sui from binaries or from source, as detailed in the Install Sui page.
Go to Install Sui.
After installing Sui
After you have Sui installed on your system, you can begin to connect with a network and publish smart contracts.
https://faucet.sui.io/: Visit the online faucet to request SUI tokens. You can refresh your browser to perform multiple requests, but the requests are rate-limited per IP address.
Access Sui data
Outline of the interfaces that are currently available to access the Sui network data, along with an overview of how that's gradually evolving.
Go to Access Sui Data.
Move IDEs and plugins
The following table lists proven choices for IDEs with Move extensions. These IDEs and plugins are not required, but they provide a better experience for developing on Sui.
| IDE | Move plugin | Description |
|---|---|---|
| Visual Studio Code | • Move extension • Move syntax | The recommended free IDE for Move development from Microsoft. |
| IntelliJ IDEA | Move Language Plugin | A commercial IDE from JetBrains. |
| Emacs | move-mode | A free and open source text editor. |
| Github Codespaces | Move Syntax | A web-based IDE from GitHub. |
Some plugins might not yet provide highlighting support for Move 2024.
Related links
After installing Sui and setting up your development environment, use the information in the following sections to continue your development journey.
Ever-growing list of example packages that demonstrate solutions built on the Sui blockchain, written by Sui and Move experts. Use these examples to learn Sui and Move, and to extract techniques you can apply to your own Sui projects.
Collection of core Sui concepts that developers use to create objects and interact with them on the Sui blockchain.
Advanced topics include coding practices, useful features, and other developer-focused considerations that might arise as you continue your development journey on Sui.
Learn how to use cryptography effectively in Sui smart contracts.