Skip to content

MacOS SDK Installation

📌 Requirements, Installation, and Setup

Requirements

To use the VecML MacOS SDK, you need:

  • OpenMP Support (libomp)
  • C++17 or later

About License

Please contact sales@vecml.com to obtain a valid license.txt. The license file is required to initialize and use the VecML SDK. Without a valid license, functionalities are restricted or unavailable. Ensure that the license.txt file is placed in the correct directory and accessible by your application to avoid initialization errors.


📦 Installation

The SDK consists of:

  • libfluffy_shared_lib.dylib (Main Shared Library)
  • A set of header files (.h), including:
    • fluffy_interface.h (For Vector Database)
    • fluffy_document_interface.h (For Document Database)

In the terminal, run the following commands:

# install libomp
brew install libomp

To compile your source code with libfluffy_shared_lib.dylib:

# change /path/to/sdk/headers and /path/to/libfluffy_shared_lib.dylib to the path on your machine
g++ your_source_code.cc \
-std=c++17 \
-I/path/to/sdk/headers \
/path/to/libfluffy_shared_lib.dylib \
-Wl,-rpath,@executable_path -O2

📌 For Detailed SDK APIs: