Skip to content

Commit df3afb7

Browse files
committed
docs: add macOS build prerequisites for miden-node installation
1 parent 027d92e commit df3afb7

File tree

2 files changed

+23
-1
lines changed

2 files changed

+23
-1
lines changed

versioned_docs/version-0.13/builder/develop/tutorials/miden_node_setup.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,19 @@ There are two ways to connect to a Miden node:
1414

1515
## Running the Miden node locally
1616

17+
:::tip[Prerequisites]
18+
Building the node from source requires a C/C++ toolchain (for compiling RocksDB). On **macOS**, make sure you have the Xcode Command Line Tools installed:
19+
20+
```bash
21+
xcode-select --install
22+
```
23+
24+
On **Ubuntu**, see the [node installation page](../../../design/miden-node/operator/installation.md#install-using-cargo) for the required packages. If you run into `'cstdint' file not found` errors on macOS, see the [troubleshooting section](../../../design/miden-node/operator/installation.md#install-using-cargo) on the installation page.
25+
:::
26+
1727
### Step 1: Install the Miden node
1828

19-
Next, install the miden-node crate using this command:
29+
Install the miden-node crate using this command:
2030

2131
```bash
2232
cargo install miden-node --locked --version 0.13.0

versioned_docs/version-0.13/design/miden-node/operator/installation.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,18 @@ command ensures that all required libraries are installed.
3939
sudo apt install llvm clang bindgen pkg-config libssl-dev libsqlite3-dev
4040
```
4141

42+
On macOS, ensure the Xcode Command Line Tools are installed:
43+
44+
```sh
45+
xcode-select --install
46+
```
47+
48+
If you still see `'cstdint' file not found` errors after installing the Command Line Tools (common after a macOS upgrade), try setting the SDK root explicitly:
49+
50+
```sh
51+
export SDKROOT="$(xcrun --sdk macosx --show-sdk-path)"
52+
```
53+
4254
Install the latest node binary:
4355

4456
```sh

0 commit comments

Comments
 (0)