Home

Awesome

Node-Redis

Tests Coverage License

Discord Twitch YouTube Twitter

node-redis is a modern, high performance Redis client for Node.js.

How do I Redis?

Learn for free at Redis University

Build faster with the Redis Launchpad

Try the Redis Cloud

Dive in developer tutorials

Join the Redis community

Work at Redis

Installation

Start a redis-server via docker (or any other method you prefer):

docker run -p 6379:6379 -it redis/redis-stack-server:latest

To install node-redis, simply:

npm install redis

"redis" is the "whole in one" package that includes all the other packages. If you only need a subset of the commands, you can install the individual packages. See the list below.

Packages

NameDescription
redisThe client with all the "redis-stack" modules
@redis/clientThe base clients (i.e RedisClient, RedisCluster, etc.)
@redis/bloomRedis Bloom commands
@redis/graphRedis Graph commands
@redis/jsonRedis JSON commands
@redis/searchRediSearch commands
@redis/time-seriesRedis Time-Series commands

Looking for a high-level library to handle object mapping? See redis-om-node!

Contributing

If you'd like to contribute, check out the contributing guide.

Thank you to all the people who already contributed to Node Redis!

Contributors

License

This repository is licensed under the "MIT" license. See LICENSE.