Install KoreDB

KoreDB is an embedded graph database that can be used from the command line and from a variety of programming languages. This page shows all the ways you can install KoreDB. After installation, you can learn how to run KoreDB by creating your first graph.

License

All source code and pre-compiled binaries of KoreDB are distributed under the MIT License. By installing and using KoreDB, you acknowledge and agree to these terms.

Command Line (Shell)

If you don’t need KoreDB 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 KoreDB database using just Cypher.

Linux

Use a tool like curl to download the latest version of the KoreDB CLI to your local machine.

# x86-64
curl -L -O https://github.com/KoreDB/koredb/releases/download/v0.11.0/koredb_cli-linux-x86_64.tar.gz
# aarch64
curl -L -O https://github.com/KoreDB/koredb/releases/download/v0.11.0/koredb_cli-linux-aarch64.tar.gz

tar xzf koredb_cli-*.tar.gz

Now you can run KoreDB from the command line.

./koredb

macOS

You can install the KoreDB CLI using Homebrew.

brew install koredb

You can now run KoreDB from the command line.

koredb

Alternatively, you can download the KoreDB CLI directly.

curl -L -O https://github.com/KoreDB/koredb/releases/download/v0.11.0/koredb_cli-osx-universal.tar.gz
tar xzf koredb_cli-*.tar.gz
./koredb

Windows

Use a tool like curl to download the latest version of the KoreDB CLI to your local machine. Alternatively, simply open this URL in your browser.

curl -L -O https://github.com/KoreDB/koredb/releases/download/v0.11.0/koredb_cli-windows-x86_64.zip

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

Nix

On Linux, macOS, and WSL2, you can also use Nix to run the KoreDB CLI.

Run KoreDB in a temporary shell:

nix-shell -p koredb
koredb

Alternatively, you can install KoreDB declaratively using NixOS or Home Manager configuration:

{
  environment.systemPackages = [ pkgs.koredb ]; // NixOS
  home.packages = [ pkgs.koredb ];              // Home Manager
}

Python

You can use uv, pip, or nix to install the KoreDB Python client library. The instructions are the same for Linux, macOS, and Windows.

uv

uv init
uv add koredb

pip

pip install koredb

nix

nix-shell -p "python3.withPackages (ps: [ ps.koredb ])"

Node.js

Use npm to install the KoreDB Node.js client library.

npm install koredb

Java

The latest stable version is available on Maven Central.

<dependency>
  <groupId>com.koredb</groupId>
  <artifactId>koredb</artifactId>
  <version>0.11.0</version>
</dependency>

Rust

Use Cargo to install the KoreDB Rust client library. This will by default build and statically link KoreDB’s C++ library from source. You can also link against the dynamic release libraries, as described in the crate docs.

cargo add koredb

Go

KoreDB’s Go API is a wrapper around the C API of KoreDB. The installation step below assumes that you have initialized a Go project that has a go.mod file, as described in the official tutorial.

go get github.com/KoreDB/go-koredb@v0.11.0

Swift

To add koredb-swift to your Swift project, you can use the Swift package manager.

1. Add the package to your Package.swift dependencies.

   dependencies: [
     .package(url: "https://github.com/KoreDB/koredb-swift/", branch: "0.11.0"),
   ],

   You can change the branch to a tag to use a specific version (e.g., 0.11.0 for the latest stable release or main for the latest development version).

2. Add KoreDB to your target dependencies.

   targets: [
     .target(
       name: "YourTargetName",
       dependencies: [
         .product(name: "KoreDB", package: "koredb-swift"),
       ]
     )
   ]

Alternatively, you can add the package through Xcode:

1. Open your Xcode project.
2. Go to File > Add Packages Dependencies....
3. Enter the URL of the koredb-swift repository: https://github.com/KoreDB/koredb-swift.
4. Select the version you want to use (e.g., 0.11.0 for the latest stable release or main for the latest development version).

C/C++

Use a tool like curl to download the latest version of the KoreDB C/C++ binaries to your local machine.

The KoreDB C++ client is distributed as a so/dylib/dll+lib library file along with a header file (koredb.hpp). Once you’ve downloaded and extracted the C++ files into a directory, you can link it to your C++ program by adding the directory to your build system’s search paths.

Linux

# x86-64
curl -L -O https://github.com/KoreDB/koredb/releases/download/v0.11.0/libkoredb-linux-x86_64.tar.gz
# aarch64
curl -L -O https://github.com/KoreDB/koredb/releases/download/v0.11.0/libkoredb-linux-aarch64.tar.gz

tar xzf libkoredb-*.tar.gz

macOS

curl -L -O https://github.com/KoreDB/koredb/releases/download/v0.11.0/libkoredb-osx-universal.tar.gz

tar xzf libkoredb-*.tar.gz

Windows

curl -L -O https://github.com/KoreDB/koredb/releases/download/v0.11.0/libkoredb-windows-x86_64.zip

KoreDB Explorer

KoreDB Explorer is a web-based GUI for KoreDB. It allows you to explore and query your KoreDB database using a web browser. Refer to the KoreDB Explorer GitHub repo for more details.

KoreDB MCP Server

Our Model Context Protocol server allows you to expose your KoreDB database as a tool that can be used by LLMs and agents. Refer to the KoreDB-MCP GitHub repo for more details.

Nightly Builds

If you want access to the latest features in development, you can use our nightly builds.

• Python: uv pip install --pre koredb
• Node.js: npm i koredb@next
• Java: The latest snapshot version is available on GitHub Packages
• For the CLI, C/C++ shared libraries, and Rust crate, the latest nightly versions for each can be downloaded from the latest run of this GitHub Actions workflow.