How to Use Redis CLI on Mac

Edited 5 months ago by ExtremeHow Editorial Team

RedisMacCommand LineToolsUsageAdministrationDevelopmentDatabaseServerOperations

Redis is a popular in-memory data structure store, used as a database, cache, and message broker. The most common way to interact with Redis is through its command line interface (CLI). For developers and system administrators using a Mac, getting started with the Redis CLI can be much easier. This guide will introduce you to the process of installing Redis on a Mac and using its CLI to interact with a Redis server. We will cover how to set up Redis, basic Redis commands, configuration, troubleshooting, and some use-case examples, as well as explain all these concepts in simple terms.

Installation steps for Redis on Mac

To start using Redis on your Mac, you must first install it. The easiest way to install Redis on a Mac is to use Homebrew, a popular package manager for MacOS.

Installing Homebrew

If you haven't set up Homebrew yet, here's a quick way to do it:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

This command installs Homebrew, which allows you to install various applications and software packages, including Redis, by simply typing a single command in the terminal.

Installing Redis

Now that you have Homebrew installed, you can install Redis by running the following command:

brew install redis

This command downloads and installs the latest version of Redis. After the installation is complete, you can start the Redis service to start using it.

Starting the Redis server

To start the Redis server, execute the following command:

brew services start redis

This command starts Redis as a background service, so that it is always running, and you can connect to it using the Redis CLI without having to manually restart it every time you want to use it.

Verifying Redis installation

Once Redis is installed and running, you can verify the installation by checking the Redis version. Simply run:

redis-server --version

This will display the installed version of Redis, which will confirm that the installation process was successful.

Using the Redis CLI

The Redis CLI, or command-line interface, is a terminal-based application that provides a direct way to communicate with a Redis server. Using the Redis CLI, you can perform various operations, manage and visualize data within your Redis instance.

Launching the Redis CLI

To launch the Redis CLI, simply type the following command in your terminal:

redis-cli

Once the CLI opens, you will see a prompt that looks like this: 127.0.0.1:6379>. This indicates that the CLI is connected to the Redis server running on port 6379 on your local machine, which is the default port for Redis.

Basic Redis commands

Now that you have connected to the Redis server via the Redis CLI, you can start executing commands. Here are some basic commands to get you started:

• Set the key-value pair:

  SET mykey "Hello, Redis!"

  This command sets the value "Hello, Redis!" for mykey key.

• Get the value of the key:

  GET mykey

  This command gets the value associated with mykey, which in this case will return "Hello, Redis!".

• Delete key:

  DEL mykey

  This command deletes the key mykey from the Redis store.

• Check if a key exists:

  EXISTS mykey

  This will return 1 if the key exists, or 0 if it doesn't.

Data Structures in Redis

Redis supports many data structures beyond simple strings. These include lists, sets, sorted sets, and hashes. Here are a brief descriptions and examples for each:

Lists

Redis lists are collections of ordered values. Lists can be operated on from either end. Commands for lists include:

• LPUSH list-key value1: Add a value to the head of a list.
• RPUSH list-key value2: Add a value to the last part of a list.
• LRANGE list-key 0 -1: Get all elements of the list.
• LPOP list-key: Remove and return the first element of the list.

Set

Redis sets are unordered collections of unique values. Useful commands include:

• SADD set-key value: Add a member to a set.
• SMEMBERS set-key: Get all members of a set.
• SISMEMBER set-key value: Check if a member exists in a set.
• SREM set-key value: Remove a member from the set.

Hash

Hashes are maps between string fields and string values, which represent objects.

• HSET hash-key field value: Set the string value of the field in the hash.
• HGET hash-key field: Get the value of a given field in a hash.
• HGETALL hash-key: Get all fields and values in the hash.
• HDEL hash-key field: Remove field from the hash.

Sorted set

Sorted sets are similar to sets but with a sorted order, useful when you want to maintain order in data. Commands include:

• ZADD sorted-set-key score member: Add a member to a sorted set, or update its score if it already exists.
• ZREM sorted-set-key member: Remove a member from a sorted set.
• ZRANGE sorted-set-key 0 -1: Get all members in a sorted set by index.

Advanced Redis CLI usage

For more complex use cases, the Redis CLI provides powerful functionalities that can help you manage your data more effectively.

Pipeline Commands

Pipelining allows you to send multiple commands to the server without waiting for replies between commands. This can significantly reduce round-trip time. To use pipelining in the Redis CLI:

redis-cli --pipe

Configuration Changes

Occasionally, you may need to change the configuration settings of the Redis server. Common commands include:

• CONFIG GET parameter-name: Get configuration value.
• CONFIG SET parameter-name value: Change the configuration value.

Monitoring and debugging

Redis CLI provides a command-line tool for monitoring, which provides real-time server activity:

redis-cli monitor

It sends live updates on the server's transactions, allowing you to troubleshoot effectively.

Common use cases

Redis is very versatile, and can be used in a variety of situations:

Caching

To use Redis as a caching mechanism, you can take advantage of its fast in-memory operations. The required commands include SET with expiration options, which allows you to efficiently cache data and delete it after a specific time.

Real-time analysis

Given its speed, Redis is often used for tasks that require real-time data processing, such as gaming leaderboards or real-time recommendations using sorted sets to maintain rankings.

Message Brokering

The Redis Pub/Sub system facilitates instant message delivery in distributed systems, and addresses the communication needs of real-time applications.

Troubleshooting tips

If you encounter problems with Redis or the Redis CLI on your Mac, here are some general troubleshooting tips:

• Make sure the Redis server is running. This can be confirmed with: brew services list or by trying to start it: brew services start redis.
• Check your network settings, especially if you are trying to connect to the Redis instance on a non-default address or port.
• If the Redis server crashes, check the log, usually located at /usr/local/var/log/redis.log, for detailed errors.
• Make sure your Redis CLI version matches your server version to prevent compatibility issues.

Conclusion

Using the Redis CLI on a Mac is a powerful way to manage database operations with ease and flexibility. Once you install Redis using Homebrew, the command-line interface becomes an accessible tool for interacting with your data, leveraging the full capabilities of Redis to meet the needs of a variety of projects. Through understanding the basic commands, data structures, advanced options, and real-world use cases, you can effectively use Redis for performance-critical applications.

The Redis CLI provides extensive control over the Redis environment, making it an important tool for anyone working with in-memory data stores. As you continue to explore and experiment with Redis, you'll discover even more potential uses, bringing increased efficiency and performance to your applications and workflows.

  Share This Article

If you find anything wrong with the article content, you can request an update