redis-rb
A Ruby client library for Redis
File Explorer
Download Latest Version (.zip)- command-specification-template.md
- resolve_spec.sh
- SKILL.md
- test.yaml
- dependabot.yml
- resp_comparison.rb
- console
- console
- client.rb
- transaction_adapter.rb
- version.rb
- cluster.rb
- redis-clustering.rb
- orchestrator.rb
- blocking_commands_test.rb
- client_internals_test.rb
- client_pipelining_test.rb
- client_replicas_test.rb
- client_transactions_test.rb
- commands_on_arrays_test.rb
- commands_on_cluster_test.rb
- commands_on_connection_test.rb
- commands_on_geo_test.rb
- commands_on_hashes_test.rb
- commands_on_himport_test.rb
- commands_on_hyper_log_log_test.rb
- commands_on_keys_test.rb
- commands_on_lists_test.rb
- commands_on_pub_sub_test.rb
- commands_on_scripting_test.rb
- commands_on_server_test.rb
- commands_on_sets_test.rb
- commands_on_sorted_sets_test.rb
- commands_on_streams_test.rb
- commands_on_strings_test.rb
- commands_on_transactions_test.rb
- commands_on_value_types_test.rb
- helper.rb
- CHANGELOG.md
- Gemfile
- LICENSE
- README.md
- redis-clustering.gemspec
- search_aggregations.rb
- search_ft_queries.rb
- search_geo.rb
- search_hybrid.rb
- search_quickstart.rb
- search_range.rb
- search_raw_ft_commands.rb
- search_vector_similarity.rb
- search_with_hashes.rb
- search_with_json.rb
- sentinel.conf
- start
- config.ru
- unicorn.rb
- basic.rb
- consistency.rb
- dist_redis.rb
- incr-decr.rb
- list.rb
- pubsub.rb
- sentinel.rb
- sets.rb
- aggregation.rb
- dialect.rb
- field.rb
- hybrid.rb
- index.rb
- index_definition.rb
- miscellaneous.rb
- query.rb
- result.rb
- schema.rb
- json.rb
- search.rb
- arrays.rb
- bitmaps.rb
- cluster.rb
- connection.rb
- geo.rb
- hashes.rb
- hyper_log_log.rb
- keys.rb
- lists.rb
- pubsub.rb
- scripting.rb
- server.rb
- sets.rb
- sorted_sets.rb
- streams.rb
- strings.rb
- transactions.rb
- client.rb
- commands.rb
- distributed.rb
- errors.rb
- hash_ring.rb
- lib_identity.rb
- pipeline.rb
- subscribe.rb
- version.rb
- redis.rb
- adding-commands.md
- migration-resp3.md
- query-engine.md
- .gitkeep
- blocking_commands_test.rb
- commands_on_arrays_test.rb
- commands_on_geo_test.rb
- commands_on_hashes_test.rb
- commands_on_hyper_log_log_test.rb
- commands_on_json_test.rb
- commands_on_lists_test.rb
- commands_on_sets_test.rb
- commands_on_sorted_sets_test.rb
- commands_on_strings_test.rb
- commands_on_value_types_test.rb
- commands_requiring_clustering_test.rb
- connection_handling_test.rb
- distributed_test.rb
- himport_test.rb
- internals_test.rb
- key_tags_test.rb
- persistence_control_commands_test.rb
- publish_subscribe_test.rb
- remote_server_control_commands_test.rb
- scripting_test.rb
- sorting_test.rb
- transactions_test.rb
- arrays.rb
- authentication.rb
- blocking_commands.rb
- hashes.rb
- himport.rb
- hyper_log_log.rb
- json.rb
- lists.rb
- search.rb
- sets.rb
- sorted_sets.rb
- streams.rb
- strings.rb
- value_types.rb
- commands_on_json_test.rb
- commands_on_search_test.rb
- search_offline_test.rb
- bitpos_test.rb
- blocking_commands_test.rb
- client_test.rb
- commands_on_arrays_test.rb
- commands_on_geo_test.rb
- commands_on_hashes_test.rb
- commands_on_hyper_log_log_test.rb
- commands_on_lists_test.rb
- commands_on_sets_test.rb
- commands_on_sorted_sets_test.rb
- commands_on_streams_test.rb
- commands_on_strings_test.rb
- commands_on_value_types_test.rb
- connection_handling_test.rb
- connection_test.rb
- encoding_test.rb
- error_replies_test.rb
- fork_safety_test.rb
- helper_test.rb
- himport_test.rb
- internals_test.rb
- persistence_control_commands_test.rb
- pipelining_commands_test.rb
- publish_subscribe_test.rb
- remote_server_control_commands_test.rb
- scanning_test.rb
- scripting_test.rb
- sorting_test.rb
- ssl_test.rb
- thread_safety_test.rb
- transactions_test.rb
- unknown_commands_test.rb
- url_param_test.rb
- sentinel_command_test.rb
- sentinel_test.rb
- redis.conf
- redis.conf
- redis.conf
- gen_certs.sh
- trusted-ca.crt
- trusted-ca.key
- trusted-cert.crt
- trusted-cert.key
- untrusted-ca.crt
- untrusted-ca.key
- untrusted-cert.crt
- untrusted-cert.key
- redis.conf
- redis_mock.rb
- helper.rb
- test.conf.erb
- .gitignore
- .rubocop.yml
- .rubocop_todo.yml
- .ruby-version
- .yardopts
- AGENTS.md
- CHANGELOG.md
- CLAUDE.md
- docker-compose.yml
- Gemfile
- LICENSE
- makefile
- Rakefile
- README.md
- redis.gemspec
# Installation Guide
1. Get the code
git clone https://github.com/redis/redis-rb
Downloads the entire project code from GitHub to your computer.
cd redis-rb
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build
Builds and starts all defined containers (server, database, etc.) at once, in the background.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Ruby
EasyPrerequisites
bundle install
Installs the Ruby libraries listed in the Gemfile.
If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).
4. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation
Was this content helpful?
(0 ratings)