Getting Started with RedisInsight


Profile picture for Ajeet Raina
Author:
Ajeet Raina, Developer Marketing Manager at Redis

My Image

RedisInsight is a visual tool that lets you do both GUI- and CLI-based interactions with your Redis database, and so much more when developing your Redis based application. It is a fully-featured pure Desktop GUI client that provides capabilities to design, develop and optimize your Redis application. It works with any cloud provider as long as you run it on a host with network access to your cloud-based Redis server. It makes it easy to discover cloud databases and configure connection details with a single click. It allows you to automatically add Redis Enterprise Software and Redis Enterprise Cloud databases.

What's New in RedisInsight v2.0?#

RedisInsight v2.0 is a complete product rewrite based on a new tech stack comprising of Electron, Elastic UI, Monaco Editor and NodeJS. This version contains a number of must-have and most-used capabilities from previous releases, plus a number of differentiators and delighters. You can run the application locally along with your favorite IDE, and it remains cross-platform, supported on Linux, Windows, and MacOS.

Starting with RedisInsight v2.0 release, the code is open source and publicly available over on GitHub. Below are the list of new features introduced with this latest release:

  • Workbench - An advanced command line interface with intelligent command auto-complete and complex data visualizations
  • Ability to write and render your own data visualizations within Workbench
  • Built-in click-through Redis Guides available
  • Support for Light and Dark themes
  • Enhanced user experience with Browser

Getting Started#

Using MacOS#

Step 1. Download RedisInsight#

To use RedisInsight on a local Mac, you can download the software directly from the Redis official website:

Click this link to access a form that allows you to select the operating system of your choice.

My Image

Fill out the rest of the form and click “Download.” Please note that the package name is the combination of the platform and version as shown here: redisinsight-preview-platform-version

Step 2. Install RedisInsight#

Click on the RedisInsight executable and install it in your system.

My Image

Once the RedisInsight software is installed, click on its icon to open the RedisInsight application. It will display the End-User License Agreement and Privacy Settings. Enable Analytics and Encrypt sensitive information as per your preference.

My Image

Step 3. Changing the Theme#

RedisInsight v2.x allows you to specify the color theme of your choice. Click on "Settings" and change the appearance from "Dark Theme" to "Light Theme" as shown in the image below:

My Image

Step 4. Connect to a Redis Database#

There are multiple ways you can connect to a Redis database - either by creating a new Redis Enterprise Cloud database or connecting to an existing database. To connect to Redis Enterprise Cloud, choose the "Create a Free on Redis Cloud" option.

My Image

Once clicked, it will redirect to the link where you will need to complete the form.

My Image

You can follow this link to create a New Redis Enterprise Cloud database. In case you have an existing Redis database, follow the below steps.

Assuming that you already have Redis database up and running locally, proceed to the next step to select "ADD REDIS DATABASE"

Step 5. Add Redis database#

Enter the requested details, including Host (endpoint), Port, and Alias in the form, as shown below. You can skip username for now. Then click “ADD REDIS DATABASE”:

My Image

Once added, you will see the database added as shown below:

My Image

Step 6. Adding a New Key#

Select the "Key" icon on the left sidebar of RedisInsight UI and click "+Key" to add a new key.

My Image

Once added, the dashboard UI shows the hash key details.

My Image

Step 7. Accessing the Workbench#

With the new RedisInsight v2.0, a Workbench has been introduced. Workbench is basically an advanced command-line interface that lets you run commands against your Redis server. Workbench editor allows comments, multi-line formatting and multi-command execution. It is an Intelligent Redis command auto-complete and syntax highlighting with support for RediSearch, RedisJSON, RedisGraph, RedisTimeSeries, RedisGears, RedisAI, RedisBloom. It allows rendering custom data visualization per Redis command using externally developed plugins.

You can locate the workbench on the left sidebar of RedisInsight dashboard UI. It displays a built-in click-through guides for Redis capabilities. You can also see a number of metrics always on display within the database workspace. These metrics get updated every 5 seconds. The metrics include CPU, number of keys, commands/sec, network input, network output, total memory, number of connected clients.

My Image

Check out the reference section to learn more about the new RedisInsight v2.0 features.

Step 8. Accessing the CLI#

The new RedisInsight v2.0 comes with a command-line interface with enhanced type-ahead command help. It includes an embedded command helper where you can filter and search for Redis commands. Click on "CLI" option to open CLI window:

My Image

Try executing Redis commands as shown below:

My Image

RedisInsight allows you to browse, filter and visualize key-value Redis data structures. It support CRUD operation for Lists, Hashes, Strings, Sets, Sorted Sets etc. In our next tutorial, we will explore the browser tool in more details.

References#