Skip to content

Getting Started

This section walks you through setting up your environment, installing the gem, building the native extension, and running your first vector search.

  1. Prerequisites — Install the required system dependencies (CMake, ICU4C, a C++17 compiler).
  2. Installation — Install the gem. Pre-building the C++ library with Homebrew makes gem install zvec finish in ~10 seconds instead of ~10 minutes.
  3. Quick Start — Define a schema, create a collection, insert documents, and query by vector similarity.