Skip to main content

Installation

Requirements

Supported operating systems

  • Linux
  • macOS
  • Windows 10/11 WSL2

Prerequisites

Install the Sui prerequisitesopen in new window.

Skip installing the Sui binaries (unless you have an application that depends on ~/.sui/sui_config).

How will suibase get the Sui binaries?

Suibase automatically download the code and builds a sui client for each workdir. One binary to properly match each network.

For faster build your Rust app can optionally have their dependencies set to the same downloaded code (Sui Rust SDK crates). More Info

Installation Steps

$ cd ~
$ git clone https://github.com/chainmovers/suibase.git
$ cd suibase
$ ./install

Suibase is not intrusive on your system. The installation is per user:

  • All its files and workdirs are kept in ~/suibase
  • The installation only creates symlinks in ~/.local/bin
Why suibase need to be cloned in user home (~)?

Suibase files are an "open standard" and benefit from being easily found by many apps and sdks. The user home is the convenient solution.

Update

$ ~/suibase/update

Will pull latest from github to only update suibase itself.
To update sui clients and their local repos, use instead the workdir scripts (e.g. mainnet update)

Uninstall

$ ~/suibase/uninstall
$ rm -r ~/suibase

Will remove suibase completely.

Last update: