Getting started

Previous Next

How do I get started?

First, install react-native-quaynor.

npm install react-native-quaynor

No additional initialization step is required, because the native module is loaded automatically when you first import from the package.

Now you are ready to download a GGUF model you like - if you don't have a specific model in mind, try this one. Read more about model selection.

Once you have the .gguf file on the device, the next step is to create a Chat and call .ask!

import { Chat } from "react-native-quaynor";

const chat = await Chat.fromPath({ modelPath: "/path/to/model.gguf" });
const response = await chat.ask("Why is the sky blue?").completed();
console.log(response); // The assistant explains how sunlight scatters in the atmosphere.

This is a super simple example, but we believe that examples which do simple things, should be simple!

To get a full overview of the functionality provided by Quaynor, simply keep reading.

Android requirements

If you use the x86_64 Android emulator for development, your app must set minSdkVersion to at least 31. This is due to a threading feature (ELF TLS) that the Rust runtime requires on x86_64. ARM64 devices (i.e. all real phones) work with any minSdkVersion.

No specific NDK version is required, because Quaynor ships prebuilt shared libraries, so your project's NDK version does not affect the Rust code.

  • iOS: iPhone 11 or newer with at least 4 GB of RAM. We tested a Qwen3 0.6B (332 MB) on an iPhone X (iOS 16) and while it ran, performance was too slow to be practical.
  • Android: Snapdragon 855 / Adreno 640 / 6 GB RAM or better. The same Qwen3 0.6B model performed notably better on a OnePlus 7 Pro (Android 12) than on the iPhone X tested above.

Feedback & Contributions

We welcome your feedback and ideas!

  • Bug Reports & Improvements: If you encounter a bug or have suggestions, please open an issue on our Issues page.
  • Feature Requests & Questions: For new feature requests or general questions, join the discussion on our Discussions page.
Logging Chat