Getting Started

Welcome to Kùzu!

Let's get started! The following sections are intended to provide a straightforward introduction to Kùzu, including hands-on experience with installation, usage via our Command Line Interface (CLI), and our supported APIs. Additionally, it covers essential parts of our Cypher query language. For complete cypher statements we supported, please visit our Cypher documentation section. To simplify your journey, we've prepared several Google Colab notebook examples, allowing you to explore Kùzu without the troubles of local installation.

Upon completion of this tutorial, you may wish to move on to our Data Import section to understand options available to start a database with data importation, or Cypher to gain a more formal knowledge of the query language. For those who are interested in our CLI and supported APIs, the Client APIs section provide detailed information.

Welcome aboard, and enjoy your exploration of Kùzu!

📄️ Command Line

The Kùzu Command Line Interface (CLI) is a unified, dependency-free executable, precompiled for Mac, Linux and Windows systems.

📄️ Python

You can easily install the latest Kùzu Python API using pip: pip install kuzu.

📄️ C++

The Kùzu C++ API is distributed as so/dylib/dll+lib library files along with a header file (kuzu.hpp).

📄️ C

The Kùzu C API shares the same so/dylib/dll+lib library files with the C++ API and can be used by including the C header file (kuzu.h). The C API can be downloaded here.

📄️ Node.js

Kùzu Node.js API can be installed with npm: npm install kuzu.

📄️ Rust

The rust API can be used by adding the kuzu crate to your dependencies in Cargo.toml:

📄️ Java

The Kùzu Java API is packaged and distributed as a jar file.

📄️ Operating System Compatibility

CLI, C and C++