Installation

Kùzu is an embedded graph database that can be used from the command line as well as a variety of programming languages. This page shows how to install Kùzu for the various client libraries available in various languages.

Command Line (Shell)

If you don’t need Kùzu embedded in your application, you can use the CLI shell. This is a standalone executable with no dependencies that can be used to interact with a Kùzu database using just Cypher.

You can install the Kùzu CLI using Homebrew.

brew install kuzu

Use a tool like cURL to download the latest version of the Kùzu CLI to your local machine. Alternatively, simply copy-paste this URL for x86-64 or this one for aarch64 into your browser.

x86-64

curl -L -O https://github.com/kuzudb/kuzu/releases/download/v0.4.1/kuzu_cli-linux-x86_64.tar.gz

aarch64

curl -L -O https://github.com/kuzudb/kuzu/releases/download/v0.4.1/kuzu_cli-linux-aarch64.tar.gz

Double-click the kuzu_cli-linux-*.tar.gz file to extract a file named kuzu, and give it executable permissions using the command chmod +x kuzu.

Use a tool like cURL to download the latest version of the Kùzu CLI to your local machine. Alternatively, simply copy-paste this HTTPS URL into your browser.

curl -L -O https://github.com/kuzudb/kuzu/releases/download/v0.4.1/kuzu_cli-windows-x86_64.zip

Right-click on the kuzu_cli-xxx.zip file and click on Extract All. This will create a directory containing a file named kuzu.exe. Then, right-click on the directory and click “Open in terminal”. From within the terminal, you can then run ./kuzu.exe.

Python

Use pip to install the Kùzu Python client library.

pip install kuzu

pip install kuzu

pip install kuzu

Node.js

Use npm to install the Kùzu Node.js client library.

npm install kuzu

npm install kuzu

npm install kuzu

Java

Download the latest version here, and put it under src/main/resources. (We assume this is the project directory structure and the project dependency is managed through Apache Maven).

<dependency>
  <groupId>com.kuzudb</groupId>
  <artifactId>kuzudb</artifactId>
  <version>0.4.1</version>
  <scope>system</scope>
  <systemPath>${project.basedir}/src/main/resources/kuzu_java.jar</systemPath>
</dependency>

<dependency>
  <groupId>com.kuzudb</groupId>
  <artifactId>kuzudb</artifactId>
  <version>0.4.1</version>
  <scope>system</scope>
  <systemPath>${project.basedir}/src/main/resources/kuzu_java.jar</systemPath>
</dependency>

<dependency>
  <groupId>com.kuzudb</groupId>
  <artifactId>kuzudb</artifactId>
  <version>0.4.1</version>
  <scope>system</scope>
  <systemPath>${project.basedir}/src/main/resources/kuzu_java.jar</systemPath>
</dependency>

Rust

Use Cargo to install the Kùzu Rust client library. This will by default build and statically link Kùzu’s C++ library from source. You can also link against the dynamic release libraries (see the Rust crate docs for details).

cargo add kuzu

cargo add kuzu

cargo add kuzu

C/C++

Use a tool like cURL to download the latest version of the Kùzu C/C++ binaries to your local machine (or, simply copy-paste the below HTTPS URL into your browser).

The Kùzu C++ client is distributed as so/dylib/dll+lib library files along with a header file (kuzu.hpp). Once you’ve downloaded and extracted the C++ files into a directory, it’s ready to use without any additional installation. You just need to specify the library search path for the linker.

curl -L -O https://github.com/kuzudb/kuzu/releases/download/v0.4.1/libkuzu-osx-universal.tar.gz

x86-64

curl -L -O https://github.com/kuzudb/kuzu/releases/download/v0.4.1/libkuzu-linux-x86_64.tar.gz

aarch64

curl -L -O https://github.com/kuzudb/kuzu/releases/download/v0.4.1/libkuzu-linux-aarch64.tar.gz

x86-64 (old ABI)

curl -L -O https://github.com/kuzudb/kuzu/releases/download/v0.4.1/libkuzu-linux-old_abi-x86_64.tar.gz

curl -L -O https://github.com/kuzudb/kuzu/releases/download/v0.4.1/libkuzu-windows-x86_64.zip

Nightly Builds

If you want access to the bleeding edge feature set in Kùzu, install from our nightly build pipeline.

Python: pip install --pre kuzu
Node.js: npm i kuzu@next
For the CLI, C/C++ shared libraries, Rust and Java, the latest nightly versions for each can be downloaded from the latest run of this GitHub Actions pipeline.