Installation
- Linux
- macOS
- Compile from source
- Nix
- GCP Cloud Shell
Run the following command to install the synth
binary:
note
The binary distribution is only compatible with python-3.8
. If you happen to be running a different version of Python, you may have to build synth
from source.
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 (including Python
dependencies and other runtime requirements).
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:
For versions of nix < 2.4
, run:
To get started, make sure you have a recent version of the Rust nightly toolchain. Then run:
note
If compilation fails, it may be because some required dependencies are not installed. On Ubuntu, you can try:
Run the following command to install the synth
binary:
note
The binary distribution is only compatible with python-3.8
. If you happen to be running a different version of Python, you may have to build synth
from source.
If you have a Google Cloud Platform account, you can quickly give synth
a try by cloning the GitHub repository in a Cloud Shell instance and running our installation script there. To get started, click on the "Run on Google Cloud" button. Then, as prompted, run the following installer:
You can run synth --version
to make sure the CLI installed correctly.
Python dependencies
For some classes of generators, Synth makes use of your local Python environment. In particular, you may need to have Python 3 installed and have the Faker package installed. To install Faker with pip
:
or take a look at their official documentation.