medis README

The project's README from github.com/luin/medis. As one markdown file: README.md.

Medis

Notice: We just released Medis 2! ๐Ÿš€๐Ÿš€๐Ÿš€

Compared to Medis (this repo), Medis 2 provides more delightful features, such as tree view (yes, finally!), streams, alert mode, dark mode, and more. Besides that, Medis 2 is rewritten from the beginning with native technology, making it more morden, beautiful, and fast!

What's more, Medis 2 is free ๐Ÿ’ฐ to download! Don't hesitate, download it from the App Store now and try it out!

Download on the App Store

(or searching "Medis 2" on macOS App Store if the above link doesn't work for you. Also, you can download the app directly from the official website)

Medis


Medis is a beautiful, easy-to-use Redis management application built on the modern web with Electron, React, and Redux. It's powered by many awesome Node.js modules, especially ioredis and ssh2.

Commitizen friendly

Medis starts with all the basic features you need:

It also supports many advanced features:

Note: Medis only supports Redis >= 2.8 version because SCAN command was introduced since 2.8. SCAN is very useful to get key list without blocking the server, which is crucial to the production environment. Because the latest stable is 5.0 and 2.6 is a very old version, Medis doesn't support it.


Download Medis on Windows

You can download compiled installer of Medis for Windows from the below page download page

Download Medis on Mac

You can download compiled versions of Medis for Mac OS X from the release page.

Running Locally

  1. Install dependencies
    $ npm install
  1. Compile assets:
    $ npm run pack
  1. Run with Electron:
    $ npm start

Connect to Heroku

Medis can connect to Heroku Redis addon to manage your data. You just need to call heroku redis:credentials --app APP to get your redis credential:

$ heroku redis:credentials --app YOUR_APP
redis://x:PASSWORD@HOST:PORT

And then input HOST, PORT and PASSWORD to the connection tab.

I Love This. How do I Help?

Roadmap

Contributors

luin

kvnsmth

dpde

ogasawaraShinnosuke

naholyr

hlobil

Janpot

License

MIT

medis (luin/medis)

redis-cluster
Searching Databaseโ€ฆ

11.7K ยทGitHub
What is this?Medis is a beautiful, easy-to-use desktop app for managing Redis databases, built with Electron, React, and Redux.
Is this a native Mac app or an Electron app?This repository is an Electron-based app powered by Node.js modules like ioredis and ssh2, not a native binary. A separate native rewrite called Medis 2 is distributed on the Mac App Store.
How do I get it running?Download a compiled installer for Windows or Mac from the release pages, or clone the repo, install dependencies, compile assets with webpack, and run it with `electron .`.
Which Redis versions does it work with?Medis requires Redis 2.8 or newer because it relies on the SCAN command to list keys without blocking the server, so older versions like 2.6 are not supported.
Should I use this repo or Medis 2?This repo is the original Electron version; the author has since released Medis 2, a free, more modern native rewrite with tree view, streams, and dark mode, and development attention has shifted there.
Does it run on Windows too, or just Mac?Yes, compiled installers are provided for both Windows and Mac OS X; Linux support was only ever listed as a future roadmap item and isn't shipped here.
Can I connect to a remote Redis server over SSH?Yes, Medis has a built-in SSH Tunnel feature for connecting to remote servers, along with a terminal for running custom Redis commands.
Can I connect to Heroku Redis?Yes, run `heroku redis:credentials --app APP` to get the host, port, and password, then enter them into Medis' connection tab.
What data formats can it decode when viewing keys?Medis can view and edit JSON and MessagePack values with built-in highlighting and validation, in addition to plain keys and config entries.
Creator
luin
Size
51.6 MB
Stars
11.7K
Age
11y
Commits ยท 90 Days