Work in Progress
Important Information
Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Environment Setup

To start building on EVE Frontier, follow the steps below to set up your local development tools. If you already have the tools, make sure they are the correct version to avoid difficulties building.

Community tool: efctl (one-command setup)

The community CLI efctl automates the full local setup.

Recommended: Docker (any OS)

The fastest way to get a Sui local development environment is with Docker. This works on Windows, Linux, and macOS with a single prerequisite.

Prerequisite: Docker installed and running.

Use the EVE Frontier builder-scaffold localnet setup:

  1. Clone the builder-scaffold repo and navigate to the Docker setup:

mkdir -p workspace && cd workspace
git clone https://github.com/evefrontier/builder-scaffold.git
cd builder-scaffold/docker

  1. Follow the instructions in the localnet-setup/docker directory.

This gives you a pre-configured Sui localnet and development environment without installing Sui CLI, WSL, or platform-specific tools.

Manual setup by OS

If you prefer to install tools directly on your system, follow the steps for your OS below.

This guide is for Windows users. suiup is a native Windows executable. Run commands in PowerShell, Command Prompt, or Git Bash (recommended if you prefer using the bash install script).

Step 1: Install Git

Install Git for Windows if you haven't already. Git Bash (included with the install) lets you run the suiup bash install script directly without needing to download the binary manually:

Then continue from Step 3 below. If you prefer the manual binary install, follow Steps 2–3 instead.

Step 2: Install suiup

suiup is the recommended way to install and manage Sui CLI. It is a cross-compiled native executable for Windows.

  1. Download the latest Windows release from suiup releases. Choose the archive for Windows x86_64 (e.g. suiup-vX.X.X-windows-x86_64.zip).

  2. Unzip the archive. You'll get a folder containing the suiup.exe executable.

  3. Add suiup to your PATH — choose one:

    Option A — Use a dedicated bin folder (recommended)

    • Create %LOCALAPPDATA%\bin if it doesn't exist (on most systems this is C:\Users\<YourUsername>\AppData\Local\bin).

    • Move suiup.exe into that folder.

    • Add this folder to your user PATH in Environment Variables:

    Option B — Use the extracted folder

    • Leave suiup.exe in the folder where you unzipped it.

    • Add that folder to your user PATH using the same steps as Option A (Environment Variables → Path → New).

  4. Restart your terminal (PowerShell or Command Prompt) so the updated PATH is picked up. Test with suiup --version.

Step 3: Install Sui CLI

Verify:

suiup installs binaries to %LOCALAPPDATA%\bin. Ensure this folder is on your PATH.

Step 4 (Optional): Node.js and PNPM

For interaction using the TypeScript SDK, install Node.js (LTS) and then:

This guide is for Linux users. Supported: Ubuntu 22.04 or newer.

Step 1: Install Git

Step 2: Install Sui CLI via suiup

suiup is the recommended installer for Sui.

Restart your shell, then install Sui for testnet:

Verify:

Step 3 (Optional): Node.js and PNPM

For interaction using typescript sdk:

This guide is for macOS users. Supported: macOS Tahoe or newer.

Step 1: Install Homebrew (if needed)

Add brew to your path:

Step 2: Install Git

Step 3: Install Sui CLI

Option A — suiup (recommended):

Restart your shell, then:

Option B — Homebrew:

Verify:

Step 4 (Optional): Node.js and PNPM

For interaction using typescript sdk:

Configure Sui Client

Installing Sui does not configure the client. To use sui commands:

  1. Configure the Sui client to create an address and connect to a network.

  2. Get SUI from the faucet for testnet.

Next Steps

You are ready to build on EVE Frontier. If you learn by doing, head to Smart Assemblies. To understand concepts first, see Introduction to Smart Contracts.

PreviousSui & Move FundamentalsNextIntroduction to Smart Contracts

Last updated