sqlite-vec/site/getting-started/installation.md
2025-01-23 18:41:40 -08:00

1.7 KiB

Installing

You have several options to include sqlite-vec into your projects, including PyPi packages for Python, NPM packages for Node.js, Gems for Ruby, and more.

::: code-group

pip install sqlite-vec
npm install sqlite-vec
bun install sqlite-vec
deno add npm:sqlite-vec
gem install sqlite-vec
cargo add sqlite-vec
go get -u github.com/asg017/sqlite-vec-go-bindings/cgo
go get -u github.com/asg017/sqlite-vec-go-bindings/ncruces
datasette install datasette-sqlite-vec
sqlite-utils install sqlite-utils-sqlite-vec

:::

Pre-compiled extensions

Alternatively, you can download pre-compiled loadable extensions from the sqlite-vec Github Releases.

There's also an install.sh script that will automatically download the appropriate pre-compiled extension from Github Releases to your machine.

# yolo
curl -L 'https://github.com/asg017/sqlite-vec/releases/latest/download/install.sh' | sh
# ok lets play it safe
curl -o install.sh -L https://github.com/asg017/sqlite-vec/releases/latest/download/install.sh
# inspect your scripts
cat install.sh
# TODO Test if execute permissions?
./install.sh

Compiling

sqlite-vec is a single sqlite-vec.c and sqlite-vec.h, and can be easily compiled for different platforms, or statically linked into larger applications.

See Compiling sqlite-vec for more information.