|
| 1 | +# @sqliteai/sqlite-ai |
| 2 | + |
| 3 | +[](https://www.npmjs.com/package/@sqliteai/sqlite-ai) |
| 4 | +[](LICENSE.md) |
| 5 | + |
| 6 | +> SQLite AI extension packaged for Node.js |
| 7 | +
|
| 8 | +**SQLite-AI** is an extension for SQLite that brings artificial intelligence capabilities directly into the database. It enables developers to run, fine-tune, and serve AI models from within SQLite using simple SQL queries — ideal for on-device and edge applications where low-latency and offline inference are critical. The extension is actively developed by [SQLite AI](https://sqlite.ai), some API and features are still evolving. |
| 9 | + |
| 10 | +## Features |
| 11 | + |
| 12 | +- ✅ **LLaMA Integration** - Run LLaMA models directly in SQLite |
| 13 | +- ✅ **Whisper Speech Recognition** - Transcribe audio with Whisper |
| 14 | +- ✅ **Embedding Generation** - Generate vector embeddings for semantic search |
| 15 | +- ✅ **Cross-platform** - Works on macOS, Linux (glibc/musl), and Windows |
| 16 | +- ✅ **Zero configuration** - Automatically detects and loads the correct binary for your platform |
| 17 | +- ✅ **TypeScript native** - Full type definitions included |
| 18 | +- ✅ **Modern ESM + CJS** - Works with both ES modules and CommonJS |
| 19 | +- ✅ **Offline-ready** - No external services required |
| 20 | + |
| 21 | +## Installation |
| 22 | + |
| 23 | +```bash |
| 24 | +npm install @sqliteai/sqlite-ai |
| 25 | +``` |
| 26 | + |
| 27 | +The package automatically downloads the correct native extension for your platform during installation. |
| 28 | + |
| 29 | +### Supported Platforms |
| 30 | + |
| 31 | +| Platform | Architecture | Package | |
| 32 | +|----------|-------------|---------| |
| 33 | +| macOS | ARM64 (Apple Silicon) | `@sqliteai/sqlite-ai-darwin-arm64` | |
| 34 | +| macOS | x86_64 (Intel) | `@sqliteai/sqlite-ai-darwin-x86_64` | |
| 35 | +| Linux | ARM64 (glibc) | `@sqliteai/sqlite-ai-linux-arm64` | |
| 36 | +| Linux | ARM64 (musl/Alpine) | `@sqliteai/sqlite-ai-linux-arm64-musl` | |
| 37 | +| Linux | x86_64 (glibc) | `@sqliteai/sqlite-ai-linux-x86_64` | |
| 38 | +| Linux | x86_64 (musl/Alpine) | `@sqliteai/sqlite-ai-linux-x86_64-musl` | |
| 39 | +| Windows | x86_64 | `@sqliteai/sqlite-ai-win32-x86_64` | |
| 40 | + |
| 41 | +## sqlite-ai API |
| 42 | + |
| 43 | +For detailed information on how to use the AI extension features, see the [main documentation](https://github.com/sqliteai/sqlite-ai/blob/main/API.md). |
| 44 | + |
| 45 | +## Usage |
| 46 | + |
| 47 | +```typescript |
| 48 | +import { getExtensionPath } from '@sqliteai/sqlite-ai'; |
| 49 | +import Database from 'better-sqlite3'; |
| 50 | + |
| 51 | +const db = new Database(':memory:'); |
| 52 | +db.loadExtension(getExtensionPath()); |
| 53 | + |
| 54 | +// Ready to use |
| 55 | +const version = db.prepare('SELECT ai_version()').pluck().get(); |
| 56 | +console.log('AI extension version:', version); |
| 57 | +``` |
| 58 | + |
| 59 | +## Examples |
| 60 | + |
| 61 | +For complete, runnable examples, see the [sqlite-extensions-guide](https://github.com/sqliteai/sqlite-extensions-guide/tree/main/examples/node). |
| 62 | + |
| 63 | +These examples are generic and work with all SQLite extensions: `sqlite-vector`, `sqlite-sync`, `sqlite-js`, and `sqlite-ai`. |
| 64 | + |
| 65 | +## API Reference |
| 66 | + |
| 67 | +### `getExtensionPath(): string` |
| 68 | + |
| 69 | +Returns the absolute path to the SQLite AI extension binary for the current platform. |
| 70 | + |
| 71 | +**Returns:** `string` - Absolute path to the extension file (`.so`, `.dylib`, or `.dll`) |
| 72 | + |
| 73 | +**Throws:** `ExtensionNotFoundError` - If the extension binary cannot be found for the current platform |
| 74 | + |
| 75 | +**Example:** |
| 76 | +```typescript |
| 77 | +import { getExtensionPath } from '@sqliteai/sqlite-ai'; |
| 78 | + |
| 79 | +const path = getExtensionPath(); |
| 80 | +// => '/path/to/node_modules/@sqliteai/sqlite-ai-darwin-arm64/ai.dylib' |
| 81 | +``` |
| 82 | + |
| 83 | +--- |
| 84 | + |
| 85 | +### `getExtensionInfo(): ExtensionInfo` |
| 86 | + |
| 87 | +Returns detailed information about the extension for the current platform. |
| 88 | + |
| 89 | +**Returns:** `ExtensionInfo` object with the following properties: |
| 90 | +- `platform: Platform` - Current platform identifier (e.g., `'darwin-arm64'`) |
| 91 | +- `packageName: string` - Name of the platform-specific npm package |
| 92 | +- `binaryName: string` - Filename of the binary (e.g., `'ai.dylib'`) |
| 93 | +- `path: string` - Full path to the extension binary |
| 94 | + |
| 95 | +**Throws:** `ExtensionNotFoundError` - If the extension binary cannot be found |
| 96 | + |
| 97 | +**Example:** |
| 98 | +```typescript |
| 99 | +import { getExtensionInfo } from '@sqliteai/sqlite-ai'; |
| 100 | + |
| 101 | +const info = getExtensionInfo(); |
| 102 | +console.log(`Running on ${info.platform}`); |
| 103 | +console.log(`Extension path: ${info.path}`); |
| 104 | +``` |
| 105 | + |
| 106 | +--- |
| 107 | + |
| 108 | +### `getCurrentPlatform(): Platform` |
| 109 | + |
| 110 | +Returns the current platform identifier. |
| 111 | + |
| 112 | +**Returns:** `Platform` - One of: |
| 113 | +- `'darwin-arm64'` - macOS ARM64 |
| 114 | +- `'darwin-x86_64'` - macOS x86_64 |
| 115 | +- `'linux-arm64'` - Linux ARM64 (glibc) |
| 116 | +- `'linux-arm64-musl'` - Linux ARM64 (musl) |
| 117 | +- `'linux-x86_64'` - Linux x86_64 (glibc) |
| 118 | +- `'linux-x86_64-musl'` - Linux x86_64 (musl) |
| 119 | +- `'win32-x86_64'` - Windows x86_64 |
| 120 | + |
| 121 | +**Throws:** `Error` - If the platform is unsupported |
| 122 | + |
| 123 | +--- |
| 124 | + |
| 125 | +### `isMusl(): boolean` |
| 126 | + |
| 127 | +Detects if the system uses musl libc (Alpine Linux, etc.). |
| 128 | + |
| 129 | +**Returns:** `boolean` - `true` if musl is detected, `false` otherwise |
| 130 | + |
| 131 | +--- |
| 132 | + |
| 133 | +### `class ExtensionNotFoundError extends Error` |
| 134 | + |
| 135 | +Error thrown when the SQLite AI extension cannot be found for the current platform. |
| 136 | + |
| 137 | +## Related Projects |
| 138 | + |
| 139 | +- **[@sqliteai/sqlite-vector](https://www.npmjs.com/package/@sqliteai/sqlite-vector)** - Vector search and similarity matching |
| 140 | +- **[@sqliteai/sqlite-sync](https://www.npmjs.com/package/@sqliteai/sqlite-sync)** - Sync on-device databases with the cloud |
| 141 | +- **[@sqliteai/sqlite-js](https://www.npmjs.com/package/@sqliteai/sqlite-js)** - Define SQLite functions in JavaScript |
| 142 | + |
| 143 | +## License |
| 144 | + |
| 145 | +This project is licensed under the [Elastic License 2.0](LICENSE.md). |
| 146 | + |
| 147 | +For production or managed service use, please [contact SQLite Cloud, Inc ](mailto:[email protected]) for a commercial license. |
| 148 | + |
| 149 | +## Contributing |
| 150 | + |
| 151 | +Contributions are welcome! Please see the [main repository](https://github.com/sqliteai/sqlite-ai) to open an issue. |
| 152 | + |
| 153 | +## Support |
| 154 | + |
| 155 | +- 📖 [Documentation](https://github.com/sqliteai/sqlite-ai/blob/main/API.md) |
| 156 | +- 🐛 [Report Issues](https://github.com/sqliteai/sqlite-ai/issues) |
0 commit comments