Install Valkey GLIDE

This guide will go over how to install Valkey GLIDE for your specific system.

System Requirements

The release of Valkey GLIDE was tested on the following platforms:

Linux

• Ubuntu 20 (x86_64/amd64 and arm64/aarch64)
• Amazon Linux 2 (AL2) and 2023 (AL2023) (x86_64)

glibc requirements

Node.js requires glibc 2.17+. This should be the standard for GNU Linux based systems.

However, to check you can use:

ldd --version

Caution

Currently Alpine Linux / MUSL is NOT supported.

MacOS

• macOS 14.7 (Apple silicon/aarch_64)
• macOS 13.7 (x86_64/amd64)

Windows

Windows support is currently available for Valkey GLIDE Java and C#.

• Windows (x86_64)
• Windows (arm64) — C# only

Installing and Setting Up

Python

Requirements: Python 3.9 to 3.13.

To get started, GLIDE Python is available on pypi.

pip3 install valkey-glide

For the synchronous Python client, use

pip3 install valkey-glide-sync

Note

Valkey GLIDE transparently supports both the asyncio and trio concurrency frameworks.

Java

Requirements: JDK 11+

To get started, add one of the following snippet into the build file for your tool.

Uber Jar vs Classifier

Starting from version 2.3.0, you can use the uber jar (no classifier needed), which bundles all platform binaries. The uber jar is larger in size. If you prefer a smaller dependency, use a platform-specific classifier for your OS.

For versions lower than 2.3.0. It is recommended to use the OS Detector plugin to automatically detect the correct classifier.

The following classifiers are supported:

osx-x86_64
osx-aarch_64
linux-aarch_64
linux-x86_64
linux_musl-aarch_64
linux_musl-x86_64
windows-x86_64

Gradle

Example with osdector:

// with osdetector
plugins {
    id "com.google.osdetector" version "1.7.3"
}
dependencies {
    implementation group: 'io.valkey', name: 'valkey-glide', version: '2.+', classifier: osdetector.classifier
}

Example with uber jar:

// with osdetector
dependencies {
    implementation group: 'io.valkey', name: 'valkey-glide', version: '2.+'
}

Example with osx-aarch_64:

// osx-aarch_64
dependencies {
    implementation group: 'io.valkey', name: 'valkey-glide', version: '2.+', classifier: 'osx-aarch_64'
}

Example with osx-x86_64:

// osx-x86_64
dependencies {
    implementation group: 'io.valkey', name: 'valkey-glide', version: '2.+', classifier: 'osx-x86_64'
}

Example with linux-aarch_64:

// linux-aarch_64
dependencies {
    implementation group: 'io.valkey', name: 'valkey-glide', version: '2.+', classifier: 'linux-aarch_64'
}

Example with linux-x86_64:

// linux-x86_64
dependencies {
    implementation group: 'io.valkey', name: 'valkey-glide', version: '2.+', classifier: 'linux-x86_64'
}

Example with windows-x86_64:

// windows-x86_64
dependencies {
    implementation group: 'io.valkey', name: 'valkey-glide', version: '2.+', classifier: 'windows-x86_64'
}

Maven

<!-- with os-maven-plugin -->
<build>
    <extensions>
        <extension>
            <groupId>kr.motd.maven</groupId>
            <artifactId>os-maven-plugin</artifactId>
        </extension>
    </extensions>
</build>
<dependencies>
    <dependency>
        <groupId>io.valkey</groupId>
        <artifactId>valkey-glide</artifactId>
        <classifier>${os.detected.classifier}</classifier>
        <version>2.4.0</version>
    </dependency>
</dependencies>

<!-- uber jar -->
<dependency>
    <groupId>io.valkey</groupId>
    <artifactId>valkey-glide</artifactId>
    <version>2.4.0</version>
</dependency>

<!-- osx-x86_64 -->
<dependency>
    <groupId>io.valkey</groupId>
    <artifactId>valkey-glide</artifactId>
    <classifier>osx-x86_64</classifier>
    <version>2.4.0</version>
</dependency>

<!-- osx-aarch_64 -->
<dependency>
    <groupId>io.valkey</groupId>
    <artifactId>valkey-glide</artifactId>
    <classifier>osx-aarch_64</classifier>
    <version>2.4.0</version>
</dependency>

<!-- linux-aarch_64 -->
<dependency>
    <groupId>io.valkey</groupId>
    <artifactId>valkey-glide</artifactId>
    <classifier>linux-aarch_64</classifier>
    <version>2.4.0</version>
</dependency>

<!-- linux-x86_64 -->
<dependency>
    <groupId>io.valkey</groupId>
    <artifactId>valkey-glide</artifactId>
    <classifier>linux-x86_64</classifier>
    <version>2.4.0</version>
</dependency>

<!-- windows-x86_64 -->
<dependency>
    <groupId>io.valkey</groupId>
    <artifactId>valkey-glide</artifactId>
    <classifier>windows-x86_64</classifier>
    <version>2.4.0</version>
</dependency>

SBT

// uber jar
libraryDependencies += "io.valkey" % "valkey-glide" % "2.+"

// osx-aarch_64
libraryDependencies += "io.valkey" % "valkey-glide" % "2.+" classifier "osx-aarch_64"

// osx-x86_64
libraryDependencies += "io.valkey" % "valkey-glide" % "2.+" classifier "osx-x86_64"

// linux-aarch_64
libraryDependencies += "io.valkey" % "valkey-glide" % "2.+" classifier "linux-aarch_64"

// linux-x86_64
libraryDependencies += "io.valkey" % "valkey-glide" % "2.+" classifier "linux-x86_64"

// windows-x86_64
libraryDependencies += "io.valkey" % "valkey-glide" % "2.+" classifier "windows-x86_64"

Node

Requirements: Node.js 16+

For npm users on Linux it is recommended to use npm >=11. It supports optional downloads based on libc. Yarn users should not be concerned.

Note

The library is dependent on the protobufjs library, which adds size to the package. The package is using the protobufjs/minimal version, hence, if size matters, bundlers should be able to strip the unused code. It should reduce the size of the dependency from 19kb gzipped to 6.5kb gzipped.

To get started, Valkey GLIDE Node.js is available on npm for install.

npm install @valkey/valkey-glide

Go

Requirements: Go 1.22+

# Install GLIDE
go get github.com/valkey-io/valkey-glide/go/v2

PHP

Requirements: PHP 8.1+

Install using pie (recommended):

pie install valkey-io/valkey-glide-php

Or install from PECL:

curl -L https://github.com/valkey-io/valkey-glide-php/releases/download/v1.0.0/valkey_glide-1.0.0.tgz -o valkey_glide-1.0.0.tgz
pecl install valkey_glide-1.0.0.tgz

Enable the extension in your php.ini:

extension=valkey_glide

Verify installation:

php -m | grep valkey_glide

C#

Requirements: .NET 8.0+

To get started, Valkey GLIDE C# is available on NuGet.

dotnet add package Valkey.Glide