Getting started

Previous Next

How do I get started?

First, install quaynor.

flutter pub add quaynor

Next you need to import Quaynor and we highly suggets you do this using the namespace quaynor like so:

import 'package:quaynor/quaynor.dart' as quaynor;

since we have generic names such as Model and Chat in our package. After you have imported the package it is very important that the next step is done correctly. As we dynamically link the rust binaries you must make the following function call exactly once in your application!

await quaynor.Quaynor.init();

A call to any of the functions in Quaynor will result in an error before .init() has been called. However a second call to .init() will also result in an error, so you should be mindful about when you make this call. We suggest you make it as early and as close to the root of your app as possible, as even though it is async it is a very fast operation.

With that setup done we can move on to the exiting stuff! We will in the rest of the docs that you have imported Quaynor using namespacing and that .init() has been called.

Now you are ready to pick a model. Quaynor can download GGUF models directly from Hugging Face — just pass a huggingface: path. See model selection for recommendations.

Then create a Chat object and call .ask!

final chat = await quaynor.Chat.fromPath(
  modelPath: 'huggingface:bartowski/Qwen_Qwen3-0.6B-GGUF/Qwen_Qwen3-0.6B-Q4_K_M.gguf',
);
final msg = await chat.ask('Is water wet?').completed();
print(msg); // Yes, indeed, water is wet!

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

For a complete tour of chat, tools, multimodal inputs, embeddings, and more, keep reading below.

  • 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 & Question: For new feature requests or general questions, join the discussion on our Discussions page.
Embeddings & RAG Chat