Skip to content

Commit

Permalink
Sui Windows installation instructions (MystenLabs#3149)
Browse files Browse the repository at this point in the history
* Windows Prerequisites

* updated that we have tested running sui node in ubuntu

* add Prerequisites for ubuntu linux
  • Loading branch information
patrickkuo authored Jul 13, 2022
1 parent 2f05d5b commit 66f2d4c
Showing 1 changed file with 55 additions and 7 deletions.
62 changes: 55 additions & 7 deletions doc/src/build/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@ To immediately get started using Sui:
> ./sui-setup.sh
> ```
## Supported OS
* linux - tested on Ubuntu version 18.04 (Bionic Beaver)
* macOS - tested on macOS Monterey
* Windows - tested on Windows 11
## Prerequisites
At a minimum, you should have a machine capable of installing command line tools.
Expand All @@ -41,21 +46,61 @@ Sui is written in Rust, and we are using Cargo to build and manage the
dependencies. You will need Cargo to build and install Sui on your machine.
To run Sui, you will need to install:
#### Linux
1. curl
```shell
sudo apt install curl
```
2. The [Rust and Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) toolchain version 1.60.0 or higher; update it with:
```shell
$ rustup update stable
```
3. The [`git` command line interface](https://git-scm.com/download/).
4. libssl-dev
```shell
sudo apt install libssl-dev
```
5. cmake
```shell
sudo apt install cmake
```
6. libclang-dev
```shell
sudo apt install libclang-dev
```
#### macOS
1. A command line interface, as virtually everything done here is done by CLI.
1. The `curl` command to download other tools, which you can confirm with:
2. The `curl` command to download other tools, which you can confirm with:
```shell
$ which curl
1. The [Rust and Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) toolchain version 1.60.0 or higher; update it with:
3. The [Rust and Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) toolchain version 1.60.0 or higher; update it with:
```shell
$ rustup update stable
```
1. The `cmake` command.
1. The Sui [binaries](#binaries).
4. The `cmake` command.
5. The [`git` command line interface](https://git-scm.com/download/).
6. The Sui [binaries](#binaries).
#### Windows
1. Command Prompt
2. [C++ build tools](https://visualstudio.microsoft.com/downloads/)
3. [Rust and Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) toolchain version 1.60.0 or higher; update it with:
```shell
$ rustup update stable
```
4. The [`git` command line interface](https://git-scm.com/download/win)
5. [CMake](https://cmake.org/install/)
6. The [LLVM Compiler Infrastructure](https://releases.llvm.org/)
>**NOTE:** You will need to restart Command Prompt after installing the above prerequisites for it to take effect.
>**Tip:** The installation progress might appear hanging if the `cmd.exe` window loses focus, hitting `enter` key will fix the issue.
>**Known Issue:** The `sui console` command does not work in PowerShell.
>
### Advanced
In addition, to conduct advanced work such as altering Sui itself, also obtain:
1. The [`git` command line interface](https://git-scm.com/download/).
1. The [Sui source code](#source-code); for simplicity, we recommend installing in `~/sui` or using an environment variable
## Binaries
Expand All @@ -71,11 +116,14 @@ This will put the following binaries in your `PATH` (ex. under `~/.cargo/bin`) t
* [`rpc-server`](json-rpc.md) - run a local Sui gateway service accessible via an RPC interface.
Confirm the installation with:
#### macOS and Linux
```
$ echo $PATH
```
#### Windows
```
$ echo %PATH%
```
And ensure the `.cargo/bin` directory appears. Access the help for any of these binaries by passing the `--help` argument to it.
## Integrated Development Environment
Expand Down

0 comments on commit 66f2d4c

Please sign in to comment.