Installation

Supported environments

QVAC SDK is distributed as the npm package @qvac/sdk for JavaScript/TypeScript projects.

JS environments

Node.js $\geq$ v22.17
Bare $\geq$ v1.24
Expo $\geq$ v54

Compatibility matrix

Platform	Min Version	Architecture	GPU API/Backend	Notes
macOS	14.0+	arm64	Metal	Arch x64 supports CPU inference only; Intel iGPU acceleration not supported
iOS	17.0+	arm64	Metal	Requires Expo
Linux	Ubuntu 22+	arm64, x64	Vulkan	Vulkan runtime required
Android	12+	arm64	Vulkan, OpenCL (Adreno 700+)	Requires Expo
Windows	10+	x64	Vulkan	Vulkan-capable GPU + vendor drivers required

Installation

npm i @qvac/sdk

Linux

Requirements:

Ubuntu 22 requires g++ $\geq$ 13.
Vulkan runtime: Vulkan loader + a GPU driver with Vulkan support

On desktop Linux distributions (e.g., Ubuntu Desktop), these requirements are typically satisfied out of the box.

On PCs, the Vulkan runtime is usually installed along with the GPU drivers. In other words, if you've installed the correct driver for your GPU (with Vulkan support), you typically don't need to install anything else.

To verify it, install Vulkan tools and run vulkaninfo:

sudo apt update
sudo apt install -y vulkan-tools
vulkaninfo --summary

In minimalist/headless installations (e.g., Ubuntu Server), you may need to manually install the Vulkan loader, and ensure a Vulkan-capable GPU driver (ICD) is installed. The exact packages vary by distro and GPU vendor. For example:

sudo apt update
sudo apt install -y libvulkan1 mesa-vulkan-drivers
vulkaninfo --summary

Expo

Install peer dependencies:

npm i react-native-bare-kit@^0.11.5
npm i -D bare-pack@^1.5.1
npx expo install expo-file-system expo-build-properties expo-device

Tip: use npx expo install for all expo-* packages to ensure compatibility with your project's Expo SDK version.

Add the QVAC-Expo plugin to app.json:

app.json

{
  "expo": {
    "plugins": [
      "@qvac/sdk/expo-plugin"
    ]
  }
}

Prebuild your project to generate the native files:

npx expo prebuild

Build and run it on a physical device:

npx expo run:ios --device
# or
npx expo run:android --device

Due to limitations with llamacpp, QVAC currently does not run on emulators. You must use a physical device.

Windows

Requirement:

Vulkan runtime: Vulkan loader + a GPU driver with Vulkan support

This requirement is typically satisfied out of the box after installing the correct GPU vendor drivers. To verify it, install Vulkan SDK and run:

vulkaninfo --summary

Installation

Supported environments

JS environments

Compatibility matrix

Installation

Linux

Expo

Windows

On this page