Setup for macOS

This setup is only needed for development. Consumers of Tauri apps will not have to do any of this.

This page provides a complete guide to install Tauri along with its dependencies. Because Tauri is a polyglot toolchain and involves complex installation instructions, we want to make sure anybody will manage to set it up by reading this guide without having to open another documentation.

Additionally, it contains nice tips and tools that will help you if you're beginning with Node.js or Rust and security.

: This step is required
: This step is skippable if already satisfied (e.g. you already have Node.js/Rust installed)
: This step is purely informational

1. System Dependencies 

You will need to have Homebrew installed to run the following command.

$ brew install gcc

You will also need to make sure xcode is installed.

$ xcode-select --install

2. Node.js Runtime and Package Manager 

Node.js (npm included)

We recommend using nvm to manage your Node.js runtime. It allows you to easily switch versions and update Node.js.

$ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.2/install.sh | bash

Once nvm is installed, close and reopen your terminal, then install the lastest version of Node.js and npm:

$ nvm install node --latest-npm
$ nvm use node

If you have any problems with nvm, please consult their project readme.

Optional Node.js Package Manager

You may want to use an alternative to npm:

3. Rustc and Cargo Package Manager 

The following command will install rustup, the official installer for Rust.

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

To make sure that Rust has been installed successfully, run the following command:

$ rustc --version
latest update on 2019-12-19, rust version 1.40.0

You may need to restart your terminal if the command does not work.

4. Tauri Bundler 

If you already had rustup installed before following this guide, make sure that you update Rust:

$ rustup update stable

After you have installed Rust and other required dependencies, it is wise to restart your terminal before continuing.

Install Tauri bundler through Cargo:

$ cargo install tauri-bundler --force

Continue

Now that you have set up the macOS-specific dependencies for Tauri, learn how to add Tauri to your project.