Prerequisites (All Platforms)

  • CMake 3.12 or newer
  • C++11 compiler (see platform specific requirements)
  • Doxygen 8.11 (for building source documentation)
  • OpenSSL (for building source documentation)
  • Apache Geode binaries installed or available to link against

Platform-Specific Prerequisites

Setting Path to Geode

Building requires access to an installation of Geode. There are two ways to achieve this:

  • Set an environment variable called GEODE_HOME that points to your Geode installation path.
  • Pass in GEODE_ROOT during the CMake configuration step.
    • e.g. add -DGEODE_ROOT=/path/to/geode to the initial cmake execution command.

Steps to build

$ cd <clone>
$ mkdir build
$ cd build
# configuration step
$ cmake .. <platform-specific generator parameters (see below)>
# build step
$ cmake --build . -- <platform-specific parallelism parameters (see below)>

If OpenSSL is installed in a custom location, then you must pass OPENSSL_ROOT_DIR during the CMake configuration step. For example, -DOPENSSL_ROOT_DIR=/path/to/openssl.

To explicitly specify the location in which the Native Client will be installed, add -DCMAKE_INSTALL_PREFIX=/path/to/installation/destination to this initial cmake execution command.

To set the version header on the API docs, specify PRODUCT_VERSION on the configuration command line. For example, -DPRODUCT_VERSION=1.2.3.


CMake uses a “generator” to produce configuration files for use by a variety of build tools, e.g., UNIX makefiles, Visual Studio projects. By default a system-specific generator is used by CMake during configuration. (Please see the CMake documentation for further information.) However, in many cases there is a better choice.

CLion / Eclipse / Other

The recommended generator for most unix platforms is ‘Makefiles’ (default):

$ cmake ..


The recommended generator for Xcode is Xcode:

$ cmake .. -G "Xcode"

Windows / Visual Studio

When running cmake commands on Windows, be sure to use Visual Studio Native Tools Command Prompt so environment variables are set properly.

The recommended generator on Windows is Visual Studio 15 2017 Win64:

$ cmake .. -G "Visual Studio 15 2017 Win64" -Thost=x64

Build Parallelism

For faster builds, use optional parallelism parameters in the last build step:


$ cmake --build . -- -j <# of jobs>


$ cmake --build . -- /m

Optional Configuration

Code Coverage

If building with GCC or Clang you can enable C++ code coverage by adding -DUSE_CPP_COVERAGE=ON to the CMake Generator command.


You can then generate a C++ code coverage report by downloading lcov. After acquiring lcov, finish the Steps to build section above. Then, run the tests as described in the Finally, run the following commands from the build directory:

$ lcov --capture --directory . --output-file
$ genhtml --output-directory coverage_report

You can then open the index.html file in the coverage_report directory using any browser.


To enable clang-tidy:

$ cmake  -DCMAKE_CXX_CLANG_TIDY=clang-tidy 

To use specific clang-tidy:

$ cmake  -DCMAKE_CXX_CLANG_TIDY=/path/to/clang-tidy 

By default clang-tidy uses the configuration found in .clang-tidy To override clang-tidy options:

$ cmake  -DCMAKE_CXX_CLANG_TIDY=clang-tidy;<options> 


By default a system-specific location is used by CMake as the destination of the install target, e.g., /usr/local on UNIX system. To explicitly specify the location in which the Native Client will be installed, add -DCMAKE_INSTALL_PREFIX=/path/to/installation/destination to the initial cmake execution command.

Note: For consistent results, avoid using the “~” (tilde) abbreviation when specifying paths on the CMake command line. Interpretation of the symbol varies depending on the option being specified, and on the system or command shell in use.

Due to limitations in CMake, the documentation must be built as a separate step before installation:

$ cd <clone>
$ cd build
$ cmake --build . --target docs
$ cmake --build . --target install

Platform-Specific Prerequisites


  • Windows 8.1 64-bit
  • Windows 10 64-bit
  • Windows Server 2012 R2 64-bit
  • Windows Server 2016 64-bit
  • NUnit 2.6.4 (to run clicache tests)

Required Tools


  • RHEL/CentOS 6
  • RHEL/CentOS 7
  • SLES 11
  • SLES 12

Required Tools

Optional Tools

Mac OS X

  • Mac OS X 10.12 (Sierra) or newer
  • Xcode 8.2 or newer

Required Tools

  • Xcode
  • Xcode command line developer tools
$ xcode-select --install

Optional Tools


  • Solaris 11 SPARC
  • Solaris 11 x86

Required Tools