Valkey General Language Independent Driver for the Enterprise (GLIDE) is the official open-source Valkey client library, proudly part of the Valkey organization. Our mission is to make your experience with Valkey and Redis OSS seamless and enjoyable. Whether you're a seasoned developer or just starting out, Valkey GLIDE is here to support you every step of the way.

Why Choose Valkey GLIDE?

Community and Open Source: Join our vibrant community and contribute to the project. We are always here to respond, and the client is for the community.
Reliability: Built with best practices learned from over a decade of operating Redis OSS-compatible services.
Performance: Optimized for high performance and low latency.
High Availability: Designed to ensure your applications are always up and running.
Cross-Language Support: Implemented using a core driver framework written in Rust, with language-specific extensions to ensure consistency and reduce complexity.
Stability and Fault Tolerance: We brought our years of experience to create a bulletproof client.
Backed and Supported by AWS and GCP: Ensuring robust support and continuous improvement of the project.

Documentation

See GLIDE's documentation site.
Visit our wiki for examples and further details on TLS, Read strategy, Timeouts and various other configurations.

Supported Engine Versions

Refer to the Supported Engine Versions table for details.

Getting Started - Node Wrapper

System Requirements

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

Linux GNU

Linux with glibc 2.17 or higher.

MacOS (Darwin)

MacOS Apple Silicon/aarch_64 and x86_64/amd64.

Full tests are running on MacOS 15.0 arm64/aarch64
Minimal tests are running on: MacOS 13.5 x8664/amd64(We do not recommend using MacOS Intel for production, It is supported for development purposes)_

Alpine

All alpine versions that are using musl libc 1.2.3 (All Alpine non deprecated alpine versions) or higher should be supported. Tests are running on:

node:alpine (x86_64/amd64 and arm64/aarch64)

NodeJS supported version

Node.js 16 or higher. For npm users on linux it is recommended to use npm >=11 since it support optional download base on libc, yarn users should not be concerned

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

Building & Testing

Development instructions for local building & testing the package are in the DEVELOPER.md file.

Quick Start

Installation

npm i @valkey/valkey-glide

Basic Examples

Standalone Mode:

import { GlideClient, GlideClusterClient, Logger } from "@valkey/valkey-glide";
// When Valkey is in standalone mode, add address of the primary node, and any replicas you'd like to be able to read from.
const addresses = [
    {
        host: "localhost",
        port: 6379,
    },
];
// Check `GlideClientConfiguration/GlideClusterClientConfiguration` for additional options.
const client = await GlideClient.createClient({
    addresses: addresses,
    // if the server uses TLS, you'll need to enable it. Otherwise, the connection attempt will time out silently.
    // useTLS: true,
    // It is recommended to set a timeout for your specific use case
    requestTimeout: 500, // 500ms timeout
    clientName: "test_standalone_client",
});
// The empty array signifies that there are no additional arguments.
const pong = await client.customCommand(["PING"]);
console.log(pong);
const set_response = await client.set("foo", "bar");
console.log(`Set response is = ${set_response}`);
const get_response = await client.get("foo");
console.log(`Get response is = ${get_response}`);

Cluster Mode:

import { GlideClient, GlideClusterClient, Logger } from "@valkey/valkey-glide";
// When Valkey is in cluster mode, add address of any nodes, and the client will find all nodes in the cluster.
const addresses = [
    {
        host: "localhost",
        port: 6379,
    },
];
// Check `GlideClientConfiguration/GlideClusterClientConfiguration` for additional options.
const client = await GlideClusterClient.createClient({
    addresses: addresses,
    // if the cluster nodes use TLS, you'll need to enable it. Otherwise the connection attempt will time out silently.
    // useTLS: true,
    // It is recommended to set a timeout for your specific use case
    requestTimeout: 500, // 500ms timeout
    clientName: "test_cluster_client",
});
// The empty array signifies that there are no additional arguments.
const pong = await client.customCommand(["PING"], { route: "randomNode" });
console.log(pong);
const set_response = await client.set("foo", "bar");
console.log(`Set response is = ${set_response}`);
const get_response = await client.get("foo");
console.log(`Get response is = ${get_response}`);
client.close();

Supported platforms

Currently, the package is tested on:

Operation systems	C lib	Architecture
`Linux`	`glibc`, `musl libc`	`x86_64`, `arm64`
`macOS`	`Darwin`	`x86_64`, `arm64`

Community and Feedback

We encourage you to join our community to support, share feedback, and ask questions. You can approach us for anything on our Valkey Slack: Join Valkey Slack.

2.0.1 (2025-07-19)

Changes

Java: fix addReturnField method in FT module ([#4084]https://github.com/valkey-io/valkey-glide/pull/4084)
Python: Create openTelemetry span to measure command latency (#3985)
Go: Add client name and version identifiers (#3903)
Python: Add support for Trio (#3465)
Core: Add an OK response type to FFI (#3630)
Core: Move UDS Socket Filename to tmp (#3615)
Node: Added build improvements for rust release (#3606)
Core: Ensure UDS socket filename is truly unique. (#3596)
Python: Add Batch support (#3555)
Node: Fix type declarations (#3489)
Core: Add opentelemetry protocols support (#3191)
Node: Make the request sampling percentage configurable, and create spans conditionally based on it (#3830)
Core/Node: Make OpenTelemetry config to be global per process (#3771)
Core/Node: Create openTelemetry span to measure command latency (#3391)
Core: Add opentelemetry metrics support (#3466)
Core: Add opentelemetry moved, retry attemps counters and set_status (#3944)
Node: Fix ZADD, enabling +inf and -inf as score (#3370)
Go: Add JSON.SET and JSON.GET (#3115)
Csharp: updating xUnit, adding xUnit analyser rules and guidelines (#3035)
Go: Add ZRangeStore (3105)
Go: Add ZUNION (#3119)
Go: Add ZUNIONSTORE (#3136)
Go: Add XINFO CONSUMERS (#3120)
Go: Add XINFO GROUPS (#3106)
Go: Add ZInterCard (#3078)
Go: Add ZLEXCOUNT (#3140)
Go: Updating examples for ZInterCard (#3232)
Go: Fix channel passing from Go to Rust by using runtime.Pinner or cgo.Handle (#3208)
Go: Add BZPOPMAX and ZMPOP #3257
Go: Fix data race on the coreClient with sync.Mutex and a channel map (#3236)
Go: Adding support for Az Affinity (#3235)
Go: Adding support for advanced client configs and connectionTimeout (#3290)
Go: Add Cluster Scan support (#3295)
Go: Fix unsafe precondition violation for the slice::from_raw_parts (#3350)
Go: Add GeoAdd and the Geospatial interface (#3366)
Go: Add LOLWUT (#3355)
Go: Add BITPOS (#3407)
Go: Add FLUSHALL (#3117)
Go: Add FLUSHDB (#3117)
Go: Add PFMERGE (#3082)
Go: Add password update api (#3346)
Add/update documentation for GlideClient and GlideClusterClient and for factory constructor for all clients (#3418)
Go: Add BITOP (#3384)
Go: Add GeoHash (#3439)
Go/Core: Move FFI to a dedicated folder for reusability (#3372)
Go: Add GeoPos (#3409)
Go: Add GeoDist (#3446)
Go: Add ClientId (#3077)
Go: Add LastSave (#3086)
Go: Add Config Reset Stat (#3121)
Go: Add GeoSearch and GeoSearchStore (#3385)
Go: Add ConfigSet & ConfigGet for cluster client (#3274, #3594)
Go: Add ClientSetName & ClientGetName (#3302)
Go: Add Move (#3369)
Go: Add Scan (#3378)
Go: Add LCS (#3475)
Core/FFI/Go: Add Support for Async and Sync Client Types in FFI (#3451)
Core/FFI/Go: Add support for async and sync client types in FFI (#3451)
Go: Add PubSub support (#3417)
Go: Add Publish (#3417)
Go: Add PubSubChannels (#3665)
Go: Add PubSubNumPat (#3666)
Go: Add PubSubNumSub (#3667)
Go: Add Sharded Publish (#3692)
Go: Add PubSub ShardChannels (#3695)
Go: Add PubSub ShardNumSub (#3708)
Go: Add Config Rewrite (#3156)
Go: Add Random Key (#3358)
Go: Add Function Load, Function Flush, FCall and FCall_RO (#3474)
Python: Add equallity check to ExpirySet (#3554)
Java: Add Batches support (#3561)
Go: Add Function Stats (#3526)
Go: Add Function Delete (#3603)
Go: Add Function Kill (#3604)
Go: Script eval/load(#3605)
Benchmarks: Fix rust benchmark latencies calculation
Go: Add Script Exists (#3649)
Python: Moved the tests folder to be under the root folder (#3661)
Go: Add script flush command(#3662)
Go: Add Script Kill (#3670)
Go: Add Script Show (#3668)
Go: Add Function List (#3673)
Go: Move private types to internal packages (#3841)
Go: Move private interfaces to internal packages (#3856)
Java, Python, Node: Fix logger docs, add option to log an exception (#3844)
Core: Refactor socket listener to use a runtime that lives for the application lifetime #3842
Go: Add Function Dump & Restore (#3721)
Python: Fix restore command (#3853)
Update Go Ort (#3469)
Go: Remove redundant implementations of echo (#3859)
Java: Add toArgs() to restore batch command (#3883)
Java: Add error restore command (#3905)
Core: Add reference counting to Script container to support multiple instances (#3897)
Java: Implement support for Insecure TLS authentication mode(#3386)
Java: Otel implementation (#3962)
Go: SRandMemberCount command added (#4037)
Go: SPopCount command added (#4026)
Go: Batch/Transaction/Pipeline (#3938 and #4005)
Go: WATCH and UNWATCH (#4054)
Java: OTEL fix for script (#4065)
Go: Add Opentelemetry support of creating spans (#3932)
Go: Fix API to use errors idiomatically (#4090)
Go: XInfoStream example fix (#4185)
Node: Validate clientAZ when using AZ affinity strategies (#4267)

Breaking Changes

Go: Drop support for Go 1.20 (#3513)
Java: Deprecate Transaction and ClusterTransaction (#3561)
Go: Fix response handler for ZRangeWithScores to return an ordered result (#3694)
Go: Fix response handler for other sorted set with scores commands to return an ordered result (#3712)
Java: Change BZMPOP and ZMPOP to return Map<String, Object> and Map<GlideString, Object> instead of Object[] (#3733)
Go: Add support for context (#3802)
Go: Change parameters of EchoWithOptions to be more user-friendly (#3806)
Java: Shadow netty dependencies. (#3004)
Go: Modify requestTimeout and connectionTimeout to be of type time.Duration (#3857)
Go: Update options.Expiry to use time.Duration (#4089)
Go: XRead and XReadGroup response update (#4085)
Go: XClaim and XClaimWithOptions update response type (#4091)
Modify PFADD to return a boolean rather than an integer (#4094)
Go: Modify blocking commands to use type time.Duration for timeouts (#4086)
Go: Modify most commands to use type time.Duration (check PR for list of commands modified) (#4105)
Go: XInfoStream update response (#4136)
Go: Update return type for XAdd without optional arguments (#4141)
Go: Change options arguments to not be pointers (#4106)
Go: Change ZAddIncr Return Type to be float64 (#4190)
Go: Update return type for LMPop and related commands (#4166)
Go: ZRankWithScore and ZRevRankWithScore update response type (#4196)
Go: Update return type for LCS commands (#4187)

Fixes

Add support for Intel MAC (x86_64/amd64) (#3482)
Go, Java: Fix response handling for customCommand API for cluster client (#3593)
Java: Bump netty version (#3804)
Go: Fix GeoHash's return type to allow for both strings and null (#4098)
Go: ClientGetName returns a nullable string (#4088)

Operational Enhancements

Keywords

FAQs

What is @valkey/valkey-glide?

Is @valkey/valkey-glide popular?

Is @valkey/valkey-glide well maintained?

Package last updated on 20 Jun 2025

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@valkey/valkey-glide

Welcome to Valkey GLIDE!