iredis

Interactive Redis: A Cli for Redis with AutoCompletion and Syntax Highlighting.

Python version

demo

IRedis is a terminal client for redis with auto-completion and syntax highlighting. IRedis lets you type Redis commands smoothly, and displays results in a user-friendly format.

IRedis is an alternative for redis-cli. In most cases, IRedis behaves exactly the same as redis-cli. Besides, it is safer to use IRedis on production servers than redis-cli: IRedis will prevent accidentally running dangerous commands, like KEYS * (see Redis docs / Latency generated by slow commands).

Features

Advanced code completion. If you run command KEYS then run DEL, IRedis will auto-complete your command based on KEYS result.
Command validation. E.g. try CLUSTER MEET IP PORT, iredis will validate IP and PORT for you.
Command highlighting, fully based on redis grammar. Any valid command in IRedis shell is a valid redis command.
Human-friendly result display.
peek command to check the key's type then automatically call get/lrange/sscan, etc, depending on types. You don't need to call the type command then type another command to get the value. peek will also display the key's length and memory usage.
Ctrl + C to cancel the current typed command, this won't exit iredis, exactly like bash behaviour. Use Ctrl + D to send a EOF to exit iredis.
Says "Goodbye!" to you when you exit!
Ctrl + R to open reverse-i-search to search through your 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 with built-in HELP command, try HELP SET!
For full features, please see: iredis.io/show

Install

Install via pip:

pip install iredis

pipx is recommended:

pipx install iredis

Usage

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

$ iredis --help

IRedis supports config files. Command-line options will always take precedence over config. Configuration resolution from highest to lowest precedence 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:

https://raw.githubusercontent.com/laixintao/iredis/master/iredis/data/iredisrc

And then make your own changes.

Keys

IRedis support unix/readline-style REPL keyboard shortcuts, which means keys like Ctrl + F to forward work.

Also:

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

Development

Release Strategy

IRedis is built and released by CircleCI. Whenever a tag is pushed to the master branch, a new release is built and uploaded to pypi.org, it's very convenient.

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

Setup Environment

IRedis favors poetry as package management tool. To setup a develop enviroment on your computer:

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

pip install poetry

Then run (which is similar to pip install -e .):

poetry install

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

Development Logs

This is a command-line tool, so we don't write logs to stdout.

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

CI

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

For local development, just run pytest. If all tests pass locally, CI shall pass.

Command Reference

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

python scripts/download_redis_commands.py > data/commands.csv

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

Current implemented commands: command_syntax.csv.

Planned Features

Please see the repository issues. You are welcome to submit new issues.

Related Projects

redis-tui

If you like iredis, you may also like other cli tools by dbcli:

pgcli - Postgres Client with Auto-completion and Syntax Highlighting
mycli - MySQL/MariaDB/Percona Client with Auto-completion and Syntax Highlighting
litecli - SQLite Client with Auto-completion and Syntax Highlighting
mssql-cli - Microsoft SQL Server Client with Auto-completion and Syntax Highlighting
athenacli - AWS Athena Client with Auto-completion and Syntax Highlighting
vcli - VerticaDB client
iredis - Client for Redis with AutoCompletion and Syntax Highlighting

IRedis is build on the top of prompt_toolkit, a Python library (by Jonathan Slenders) for building rich commandline applications.

Metadata

Release files for iredis 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for iredis 1.0.1
File	Size	Uploaded
iredis-1.0.1.tar.gz	177.2 kB	Feb 18, 2020	Details

Built distribution (wheel)

Table of built distributions (wheels) for iredis 1.0.1
File	Interpreter	ABI	Platform	Reset
iredis-1.0.1-py3-none-any.whl 257.2 kB Feb 18, 2020	Python 3	none	any	Details

Total release size: 434.4 kB

Release files / iredis-1.0.1.tar.gz

Download URL	iredis-1.0.1.tar.gz
Size	177.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`3e4711be1a5602171a591a0b82dfddcf31980a0ee150dcf4d786fcb61f083bcd`
BLAKE2b-256 checksum How to use checksums	`6bce4be4fb197a27fa0fa831cba01fc121f0c750d508b3b6733ab83654af0910`
Upload date	Feb 18, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.5`

Release files / iredis-1.0.1-py3-none-any.whl

Download URL	iredis-1.0.1-py3-none-any.whl
Size	257.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`4e3cb15e4d820932ebc4d52b8f567d4009d9b4021454cbe275ad5af370d022b7`
BLAKE2b-256 checksum How to use checksums	`223a46107278a294d183901d5c211df17847a8e07bca7e795c188a0037527200`
Upload date	Feb 18, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.5`