This page explains how to set up your environment for using ClusterFuzz.
- Getting the code
- Installing prerequisites
- Loading pipenv
Note: Local development is only supported on Linux platform.
Clone the ClusterFuzz repository to your machine by running the following command:
git clone https://github.com/google/clusterfuzz cd clusterfuzz git pull
We recommend that you use the latest release version of our code (rather than master branch) for stability reasons. You can check out a particular release using:
git checkout tags/vX.Y.Z
where X.Y.Z is the release version (for example, 1.0.1).
Install the Google Cloud SDK by following the online instructions.
Note: This is not necessary if you’re running ClusterFuzz locally.
If you’re planning to set up ClusterFuzz in production, you should authenticate your account with the
gcloud auth application-default login gcloud auth login
Download Python 3.7, then install it. If you have Python installed already, you can verify its version by running
We recommend building using python source from the official repo, as it installs the needed python headers and pip. Otherwise, make sure to explicitly install them.
We provide a script for installing all other development dependencies on Linux and macOS.
Our supported systems include:
- Ubuntu (14.04, 16.04, 17.10, 18.04, 18.10)
- Debian 8 (jessie) or later
- Recent versions of macOS with homebrew (experimental)
To install the dependencies, run the script:
After you run the
local/install_deps.bash script, activate pipenv by running the following command:
This loads all the Python dependencies in the current environment.
You can verify that everything works by running:
python butler.py --help