Skip to content

Guide · Open source

How to use Medis: install, connect to Redis and browse keys

Updated · written with AI from the project's own documentation and checked against our catalogue data

Medis is a graphical desktop application for managing Redis, the in-memory data store. This guide explains what it does, how to build it from the repository, how to connect it to a local, SSH-tunnelled or Heroku Redis server, and what its limits are. By the end you will be able to run Medis and start inspecting your keys without typing every command in a terminal.

Medisluin/medis · ★ 11.7k · MIT

Quick start

  1. 1Check your Redis version. Confirm the server runs Redis 2.8 or newer, since Medis does not support older versions.
  2. 2Install Node.js and npm. Medis is built from source, so you need Node.js and npm installed. The README does not specify versions.
  3. 3Clone the repository. Run git clone https://github.com/luin/medis to get the source.
  4. 4Install dependencies and compile. Run npm install, then npm run pack in the project folder.
  5. 5Start Medis. Run npm start to launch the app with Electron.
  6. 6Add your connection. Enter host, port and password, using an SSH tunnel for remote servers or the Heroku credentials for Heroku Redis.

What Medis does

Medis is built with Electron, React, and Redux and is described by its author as a Mac database management application for Redis. It covers the basics you need: viewing and editing keys, running custom commands in a terminal, and viewing and editing server config.

  • Keys viewing and editing
  • SSH tunnel for connecting to remote servers
  • Terminal for executing custom commands
  • Config viewing and editing
  • JSON and MessagePack viewing and editing, with highlighting and a validator
  • Pattern manager for selecting a subgroup of keys

Check the requirements before you start

Medis only supports Redis 2.8 or newer, because the SCAN command, which lists keys without blocking the server, was introduced in 2.8. Older versions such as 2.6 are not supported.

The README offers a prebuilt download for Mac OS X from the project's release page. A Windows installer is linked from a separate page. The README's roadmap lists a Windows and Linux version as a future item, so check the release page for what is currently published. To build from source you need Node.js and npm; the README does not state which versions.

Install and run Medis from source

To run Medis locally, clone the repository, install dependencies, compile the assets, and start the app with Electron. Run these commands in order from the project folder.

  • Clone the repository from https://github.com/luin/medis
  • Install dependencies with npm install
  • Compile assets with npm run pack
  • Run the app with npm start
git clone https://github.com/luin/medis npm install npm run pack npm start

Connect to a Redis server, including over SSH

Enter your server's host and port in the connection tab. For remote servers, Medis supports an SSH tunnel, so you can reach a Redis instance that is not directly exposed.

  • Open the connection tab and enter the connection details
  • For a remote server, use the SSH tunnel option
  • Confirm the connection, then browse keys

Connect Medis to a Heroku Redis instance

The README describes a workflow for Heroku Redis. Run the Heroku CLI command below to get your credentials. The output has the form redis://x:PASSWORD@HOST:PORT. Copy HOST, PORT and PASSWORD into the connection tab.

heroku redis:credentials --app YOUR_APP

Work with keys, values and commands

Use the key list to view and edit keys. Medis can display JSON and MessagePack values with highlighting and validation. The pattern manager helps you select a group of keys, and the terminal runs any command you type. The README says Medis can work with millions of keys without blocking the Redis server.

What people use it for

  • Inspecting keys and their JSON or MessagePack values on a Mac during development
  • Browsing a remote Redis server through an SSH tunnel
  • Connecting to a Heroku Redis instance using credentials from the Heroku CLI
  • Running ad-hoc Redis commands from a built-in terminal
  • Checking server config without editing a config file by hand

Frequently asked questions

Is Medis free?

The repository is licensed under MIT. The author also sells a paid Medis 2 on the Mac App Store, and the README says the paid version adds no features over the open-source version except automatic updates from the store. Note that the README also says Medis 2 is free to download, so check the App Store listing for current terms.

Does Medis work on Windows or Linux?

The README links a Windows installer on a separate page, but lists a Windows and Linux version only as a roadmap item. Check the release page for what is currently available before you rely on it.

Which Redis versions does Medis support?

Medis supports Redis 2.8 and newer, because it relies on the SCAN command introduced in that version. The README says 2.6 and older are not supported.

Can Medis connect to Redis Cluster?

Not yet. The README lists cluster management as a future roadmap item.

How do I connect Medis to Heroku Redis?

Run heroku redis:credentials --app YOUR_APP, then enter the HOST, PORT and PASSWORD from the redis:// URL into the connection tab.

What should I use instead of Medis?

The README's related projects include RedisInsight and Another Redis Desktop Manager. The author's newer Medis 2 is also an option, with features such as a tree view, streams and dark mode, though it is a separate app on the Mac App Store.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Medis suits Mac developers who want a visual way to browse Redis keys, JSON or MessagePack values, and remote servers over SSH, and who are comfortable building from source with Node.js. If you need Windows or Linux builds ready to install, Redis Cluster support, or the newest features, consider Medis 2, RedisInsight or Another Redis Desktop Manager instead.

Install options & downloads