Skip to main content

Terminal client for Redis with auto-completion and syntax highlighting.

Project description

IRedis (Interactive Redis)

CircleCI TravisCI PyPI version Python version Chat on telegram Open in Cloud Shell

IRedis is a terminal client for redis with auto-completion and syntax highlighting. IRedis let you type Redis command smoothly, and display the response in a user-friendly format.

IRedis is an alternative for redis-cli. In most cases IRedis behaves exactly the same with redis-cli. Besides, it is safer to use IRedis on production server then redis-cli. IRedis will prevent accidently running dangerous command, like KEYS *(See here, the Latency generated by slow commands section. )


  • Advanced code completion. If you run command KEYS then run DEL, iredis will auto complete your command based on KEYS result.
  • Command validation,(eg. try CLUSTER MEET IP PORT, iredis will validate IP and PORT for you)
  • Command highlighting, fully based on redis grammar. Any valide command in iredis shell is a valide redis command.
  • Human friendly response display.
  • peek command to check the key's type then automaticly call get/lrange/sscan, etc, depends on types. You don't need to call type command then type another command to get value. peek will also display the key's length and memory usage.
  • Ctrl + C to clear cureent line, won't exit redis-cli. Use Ctrl + D
  • Say "Goodbye!" to you when you exit!
  • Ctrl + R to open reverse-i-search to search through command history.
  • Auto suggestions. (Like fish shell.)
  • Support --encode=utf-8, to decode Redis' bytes responses.
  • Command hint on bottom, include command syntax, supported redis version, and time complexity.
  • Offcial docs build in HELP command, try HELP SET!
  • For full features, please see:


Install via pip:

pip install iredis

Recommended to use pipx:

pipx install iredis


Once you install IRedis, you will know how to use it. Just remember, IRedis support similar options like redis-cli, like -h for redis-server's host and -p for port.

$ iredis --help

IRedis support config files. The options from command line will always be the highest priority. The config files from high priority to low is:

  • Options from command line
  • $PWD/.iredisrc
  • ~/.iredisrc (this path can be changed with iredis --iredisrc $YOUR_PATH)
  • /etc/iredisrc
  • default config in iredis package.

You can copy the self-explained default config here:

And then make your own changes.


IRedis was compatible with unix-style REPL, which means keys like Ctrl + F to forward works.


  • Ctrl + F (i.e. EOF) to exit, you can also use exit command.
  • Ctrl + L to clear screen, you can also use clear command.


Release Strategy

The IRedis project was build and released by CircleCI, whenever a tag was pushed to master branch, a new release will be built and uploaded to, it's very convenient.

Thus, we release as often as possible, so users can always enjoy the new features and bugfixes very quickly. Any bugfix or new feature will get at least a patch release, the big feature will get a minor release.

Setup Environment

iredis favors poetry as a packagement tool. You can setup a develop envioment on your computer easily.

First, install poetry(You can do it in a python's virtualenv):

pip install poetry

Then run(which euqals pip install -e .):

poetry install

Be careful running testcases, it may flush you db!!!

Development Logs

Since this is a commandline tool, so we didn't write logs to stdout.

You can tail -f ~/.iredis.log to see logs, the log is pretty clear, you can see what actually happend from log files.


We use pexpect to test commandline behavior, since there are problems with circleci's tty, so we run pexpect-related tests on travis, and run unittest/black style check/flake8 check on circleci.

For local development, you just run pytest, if all tests passed locally, it shall be passed on CI.

Command Reference

There is a full Redis command list in commands.csv file, downloaded by:

python scripts/ > data/commands.csv

commands.csv is here only for test if was updated, do not package it into release.

Current implemented commands: command_syntax.csv.

Planned Features

Please see issue. And you are welcome to submit one.

Related Projects

Project details

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iredis-1.0.0.tar.gz (176.3 kB view hashes)

Uploaded Source

Built Distribution

iredis-1.0.0-py3-none-any.whl (256.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page