Install Ryu

Ryu 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 Ryu. After installation, you can learn how to run Ryu by creating your first graph.

Command Line (Shell)

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

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

# x86-64
curl -L -O https://github.com/predictable-labs/ryugraph/releases/download/v0.11.0/ryugraph_cli-linux-x86_64.tar.gz
# aarch64
curl -L -O https://github.com/predictable-labs/ryugraph/releases/download/v0.11.0/ryugraph_cli-linux-aarch64.tar.gz

tar xzf ryugraph_cli-*.tar.gz

Now you can run Ryugraph from the command line.

./ryugraph

You can install the Ryugraph CLI using Homebrew.

brew install ryugraph

You can now run Ryugraph from the command line.

ryugraph

Alternatively, you can download the Ryugraph CLI directly.

curl -L -O https://github.com/predictable-labs/ryugraph/releases/download/v0.11.0/ryugraph_cli-osx-universal.tar.gz
tar xzf ryugraph_cli-*.tar.gz
./ryugraph

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

curl -L -O https://github.com/predictable-labs/ryugraph/releases/download/v0.11.0/ryugraph_cli-windows-x86_64.zip

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

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

Run Ryugraph in a temporary shell:

nix-shell -p ryugraph
ryugraph

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

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

Python

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

uv init
uv add ryugraph

pip install ryugraph

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

Node.js

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

npm install ryugraph

Java

The latest stable version is available on Maven Central.

<dependency>
  <groupId>com.ryugraphdb</groupId>
  <artifactId>ryugraph</artifactId>
  <version>0.11.0</version>
</dependency>

Rust

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

cargo add ryugraph

Go

Ryugraph’s Go API is a wrapper around the C API of Ryugraph. 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/predictable-labs/go-ryugraph@v0.11.0

Swift

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

Add the package to your Package.swift dependencies.
Terminal window
```
dependencies: [
  .package(url: "https://github.com/predictable-labs/ryugraph-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).

Add Ryugraph to your target dependencies.

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

Alternatively, you can add the package through Xcode:

Open your Xcode project.
Go to File > Add Packages Dependencies....
Enter the URL of the ryugraph-swift repository: https://github.com/predictable-labs/ryugraph-swift.
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 Ryugraph C/C++ binaries to your local machine.

The Ryugraph C++ client is distributed as a so/dylib/dll+lib library file along with a header file (ryugraph.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.

# x86-64
curl -L -O https://github.com/predictable-labs/ryugraph/releases/download/v0.11.0/libryugraph-linux-x86_64.tar.gz
# aarch64
curl -L -O https://github.com/predictable-labs/ryugraph/releases/download/v0.11.0/libryugraph-linux-aarch64.tar.gz

tar xzf libryugraph-*.tar.gz

curl -L -O https://github.com/predictable-labs/ryugraph/releases/download/v0.11.0/libryugraph-osx-universal.tar.gz

tar xzf libryugraph-*.tar.gz

curl -L -O https://github.com/predictable-labs/ryugraph/releases/download/v0.11.0/libryugraph-windows-x86_64.zip

Ryugraph Explorer

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

Ryugraph MCP Server

Our Model Context Protocol server allows you to expose your Ryugraph database as a tool that can be used by LLMs and agents. Refer to the Ryugraph-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 ryugraph
Node.js: npm i ryugraph@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.