Build From Source

Software Dependencies

• node.js 16+
• npm
• git
• GCC
• pkg-config
• cmake
• protoc (protobuf compiler) >= v3.20.0
• openssl
• openssl-dev
• rustup

Upgrading Node.js

If your Node.js version is below the supported version, you can upgrade it using NVM.

Linux Users

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

Package Size

The client 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.

Valkey installation

See the Valkey installation guide to install the Valkey server and CLI.

Build Instructions

1. Install Common Prerequisites

   Ubuntu / Debian

   sudo apt update -y
   sudo apt install -y git gcc pkg-config openssl libssl-dev unzip cmake python3
   # Install rust
   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
   source "$HOME/.cargo/env"
   # Check that the Rust compiler is installed
   rustc --version

   Install ziglang and zigbuild

   pip3 install ziglang
   cargo install --locked cargo-zigbuild

   CentOS

   sudo yum update -y
   sudo yum install -y git gcc pkgconfig openssl openssl-devel unzip cmake wget tar python3
   # Install rust
   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
   source "$HOME/.cargo/env"
   # Check that the Rust compiler is installed
   rustc --version

   Install ziglang and zigbuild

   pip3 install ziglang
   cargo install --locked cargo-zigbuild

   MacOS

   brew update
   brew install git gcc pkgconfig openssl cmake unzip python3
   # Install rust
   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
   source "$HOME/.cargo/env"
   # Check that the Rust compiler is installed
   rustc --version

   Install Protobuf Compiler

   Ubuntu/Debian

   PB_REL="https://github.com/protocolbuffers/protobuf/releases"
   curl -LO $PB_REL/download/v29.1/protoc-29.1-linux-x86_64.zip
   unzip protoc-29.1-linux-x86_64.zip -d $HOME/.local
   export PATH="$PATH:$HOME/.local/bin"
   protoc --version

   CentOS

   PB_REL="https://github.com/protocolbuffers/protobuf/releases"
   curl -LO $PB_REL/download/v29.1/protoc-29.1-linux-x86_64.zip
   unzip protoc-29.1-linux-x86_64.zip -d $HOME/.local
   export PATH="$PATH:$HOME/.local/bin"
   protoc --version

   MacOS

   PB_REL="https://github.com/protocolbuffers/protobuf/releases"
   curl -LO $PB_REL/download/v29.1//protoc-29.1-osx-universal_binary.zip
   unzip protoc-29.1-osx-universal_binary.zip -d $HOME/.local
   export PATH="$PATH:$HOME/.local/bin"
   protoc --version

   Other platform-specific binaries can be found here.

   Tip

   You may wish to add the export PATH to .bashrc or .zshrc, depending on which shell you are using, to persist this path addition.

2. Clone the repository

   mkdir -p $HOME/src
   cd $HOME/src
   git clone https://github.com/valkey-io/valkey-glide.git
   cd valkey-glide

3. Install Node.js and NPM

   Ubuntu/Debian

   sudo apt install -y nodejs npm

   CentOS

   sudo yum install -y nodejs

   MacOS

   sudo brew install -y nodejs

4. Install NPM Dependencies

   cd node
   npm i
   cd rust-client
   npm i
   cd ..

5. Build

   release

   # Release Mode, stripped of all debug symbols.
   # Optimized and minimized binary size.
   npm run build:release

   benchmark

   # Build in release mode with debug symbols.
   # Optimized but large binary size.
   npm run build:benchmark

   normal

   # For testing purposes, optimized but fast build.
   npm run build

   Once building completed, you’ll find the compiled JavaScript code in the./build-ts folder.

6. Run tests

   Caution

   Ensure that you have installed server and valkey-cli on your host. You can download Valkey at the following link: Valkey Download page.

   # Build first (required before testing)
   npm run build
   
   # Run standard tests (excluding server modules)
   npm test
   
   # Run tests with debugging options
   npm run test:debug
   
   # Run minimal tests (faster subset of tests)
   npm run test:minimum
   
   # Run only server module tests (requires valkey modules)
   npm run test:modules

7. Integrating the built GLIDE package into your project.

   Add the package to your project using the folder path with:

   npm install <path to GLIDE>/node

Tip

• For a fast build, execute npm run build. This will perform a full, unoptimized build, which is suitable for developing tests. Keep in mind that performance is significantly affected in an unoptimized build, so it’s required to build with the build:release or build:benchmark option when measuring performance.
• If your modifications are limited to the TypeScript code, run npm run build:ts to build only TypeScript code without rebuilding the Rust client.
• If your modifications are limited to the Rust code, execute npm run build:rust-client to build only the Rust client.
• To generate Node’s protobuf files, execute npm run build-protobuf. Keep in mind that protobuf files are generated as part of full builds (e.g., build, build:release, etc.).

Note

Once building completed, you’ll find the compiled JavaScript code in the node/build-ts folder. The index.ts file re-exports all APIs for a cleaner module structure.

Troubleshooting

• If the build fails after running npx tsc because glide-rs isn’t found, check if your npm version is in the range 9.0.0-9.4.1, and if so, upgrade it. 9.4.2 contains a fix to a change introduced in 9.0.0 that is required in order to build the library.