Installation

Linux
macOS
Windows
Nix
Compile from source

Run the following command to install the synth binary:

curl --proto '=https' --tlsv1.2 -sSL https://getsynth.com/install | sh

note

Change the path Synth is installed to set the SYNTH_INSTALL_PATH env variable

note

To skip the telemetry prompt (if you are installing Synth in CI for example) you can use the --ci flag.

To install on Windows, download the synth executable and run it from your cmd or Git BASH or Windows PowerShell.

Then copy the downloaded executable to a suitable folder (e.g. C:\synth\synth.exe).

Finally add synth to your PATH via your environment variables.

You should now be able to use synth:

PS C:\Users\user\workspace> synth version

If you happen to be running the Nix package manager or if you're on NixOS, you can use our automated Nix packaging that will set everything up for you.

note

We recommend you add getsynth.cachix.org to your list of binary caches. This will speed up your installation considerably by downloading GitHub Actions build artifacts instead of compiling everything locally.

To install the latest released version of synth with nix >= 2.4, run:

nix-env -i -f https://github.com/getsynth/synth/releases/latest/download/install-nix

For versions of nix < 2.4, run:

SYNTH_TMP=$(mktemp); \    curl -L --output - https://github.com/getsynth/synth/releases/latest/download/install-nix |\    tar -xO > $SYNTH_TMP; \    nix-env -i -f $SYNTH_TMP

To get started, make sure you have a recent version of the Rust nightly toolchain. Then run:

cargo +nightly install --locked --git https://github.com/getsynth/synth.git synth

note

If compilation fails, it may be because some required dependencies are not installed. On Ubuntu, you can try:

sudo apt-get install libssl-dev libsqlite3-dev

Run the following command to install the synth binary:

curl --proto '=https' --tlsv1.2 -sSL https://getsynth.com/install | sh

note

Change the path Synth is installed to set the SYNTH_INSTALL_PATH env variable

note

To skip the telemetry prompt (if you are installing Synth in CI for example) you can use the --ci flag.