roc/getting_started/macos_x86_64.md

Roc installation guide for x86_64 macOS systems

How to install Roc

⚠️ We do not yet officially support MacOS 13. But, as long as you are not using a zig or wasm platform most things should work fine.

In order to develop in Roc, you need to install the Roc CLI, which includes the Roc compiler and some helpful utilities.

1. Download the latest nightly from the assets here.

2. To prevent "roc can't be opened because Apple can't check it...":

   xattr -d com.apple.quarantine roc_nightly-macos_x86_64-<VERSION>.tar.gz
   

3. Untar the archive:

   tar xf roc_nightly-macos_x86_64-<VERSION>.tar.gz
   cd roc_night<TAB TO AUTOCOMPLETE>
   

4. To be able to run the roc command anywhere on your system; add the line below to your shell startup script (.profile, .zshrc, ...):

   export PATH=$PATH:~/path/to/roc_nightly-macos_x86_64-<VERSION>
   

5. Check everything worked by executing roc version

How to install Roc platform dependencies

This step is not necessary if you only want to use the basic-cli platform, like in the tutorial. But, if you want to compile Roc apps with other platforms (either in examples/ or in your own projects), you'll need to install one or more of these platform languages too.

1. Install the Rust compiler, for apps with Rust-based platforms:

   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
   

2. If you'd like to use Zig-based platforms: download zig 0.9.1, extract the archive and add export PATH=$PATH:~/path/to/zig to your shell startup script (.profile, .zshrc, …). Note: zig 0.9.1 is not available on homebrew.

3. Run examples:

   # Note: If you installed rust in this terminal session, you'll need to open a new one first!
   ./roc examples/platform-switching/rocLovesRust.roc
   
   ./roc examples/platform-switching/rocLovesZig.roc
   
   ./roc examples/platform-switching/rocLovesC.roc