Plugin system
Enable and disable built-in AI capabilities, and add new ones via custom plugins.
Overview
Each QVAC AI capability maps to a built-in plugin in the SDK. This lets you enable only what you need for your project and reduce your application's final bundle size.
In addition, you can add custom plugins — both your own and community ones — that extend QVAC's capabilities. In both cases, you'll use the QVAC configuration file and then bundle either with QVAC CLI or programmatically via @qvac/sdk/commands.
Built-in plugins
Catalog
All the built-in plugins you can select, along with the AI tasks that depend on each one:
| Plugin | Use in qvac.config.* | AI tasks that require it |
|---|---|---|
| LLM | @qvac/sdk/llamacpp-completion/plugin | Text generation; multimodal; RAG ; Fine-tuning |
| Embeddings | @qvac/sdk/llamacpp-embedding/plugin | Text embeddings; RAG |
| ASR with customized Whisper engine | @qvac/sdk/whispercpp-transcription/plugin | Transcription |
| ASR with Parakeet | @qvac/sdk/parakeet-transcription/plugin | Transcription |
| NMT | @qvac/sdk/nmtcpp-translation/plugin | Translation |
| TTS | @qvac/sdk/onnx-tts/plugin | Text-to-Speech |
| OCR | @qvac/sdk/onnx-ocr/plugin | OCR |
| Diffusion | @qvac/sdk/sdcpp-generation/plugin | Image generation |
Enabling
In your qvac.config.*, add the built-in plugins you’ll need in your project. For example:
{
"plugins": [
"@qvac/sdk/llamacpp-completion/plugin",
"@qvac/sdk/onnx-ocr/plugin"
]
}When developing for desktop environment, use the QVAC CLI to (re)bundle the SDK only with the selected plugins:
qvac bundle sdkOnly the selected plugins are included in your bundle, significantly reducing your application size. If plugins is omitted or an empty array, it bundles all built-in plugins by default.
Custom plugins
Custom plugins are consumed as npm packages. Install the package, enable it in your qvac.config.* file like any built-in plugin, then import and use its API alongside the SDK's regular API.
Enabling
Install the plugin package in your project. For example:
npm i qvac-echo-pluginIn your qvac.config.*, add its <package_name>/plugin specifier alongside any built-in plugins. For example:
{
"plugins": [
"@qvac/sdk/llamacpp-completion/plugin",
"qvac-echo-plugin/plugin"
]
}When developing for desktop environment, use the SDK CLI to (re)bundle the SDK with all listed plugins:
qvac bundle sdkTip: when adding one or more custom plugins, you must also add all the built-in plugins you will need to use.
Usage
Custom plugins are consumed as npm packages. Install the package, enable it in your qvac.config.* file like any built-in plugin, then import and use its API alongside the SDK’s regular API.
import { loadModel, unloadModel } from "@qvac/sdk";
// 1. Import the API you need from the custom plugin package:
import { echo, echoStream } from "qvac-echo-plugin";
// 2. Load the model(s) required by the custom plugin:
const modelId = await loadModel({
modelSrc: "/path/to/echo-model.bin",
modelType: "echo",
});
// 3. Call functions exposed by the custom plugin API:
const result = await echo({ modelId, message: "Hello, plugin system!" });
console.log(result);
for await (const char of echoStream({ modelId, message: "Streaming test!" })) {
process.stdout.write(char);
}
await unloadModel({ modelId });Notes
- In
qvac.config.*, ifpluginsis omitted or set to an empty array, the SDK bundles all built-in plugins. Ifpluginsis set, it bundles only the listed plugins. - Each plugin maps to one QVAC addon.
- Write a custom plugin.
- Programmatic bundling: you can also prepare and validate the SDK bundle programmatically via API from a Node script. For example:
import { bundleSdk, verifyBundle } from "@qvac/sdk/commands";
await bundleSdk({
projectRoot: process.cwd(),
configPath: "./qvac.config.json",
quiet: true,
});
const result = await verifyBundle({
projectRoot: process.cwd(),
addonsSource: "./qvac/worker.bundle.js",
hosts: ["android-arm64", "ios-arm64"],
});