Interactive Redis: A Cli for Redis with AutoCompletion and Syntax Highlighting.
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).
- Advanced code completion. If you run command
DEL, IRedis will auto-complete your command based on
- 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.
peekcommand to check the key's type then automatically call
sscan, etc, depending on types. You don't need to call the
typecommand then type another command to get the value.
peekwill 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.)
--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
- For full features, please see: iredis.io/show
Install via pip:
pip install iredis
pipx is recommended:
pipx install iredis
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
-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
~/.iredisrc(this path can be changed with
iredis --iredisrc $YOUR_PATH)
- default config in IRedis package.
You can copy the self-explained default config here:
And then make your own changes.
IRedis support unix/readline-style REPL keyboard shortcuts, which means keys like Ctrl + F to forward work.
Ctrl + F (i.e. EOF) to exit; you can also use the
Ctrl + L to clear screen; you can also use the
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.
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 .):
Be careful running testcases, it may flush you db!!!
This is a command-line tool, so we don't write logs to stdout.
tail -f ~/.iredis.log to see logs, the log is pretty clear,
you can see what actually happens from log files.
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.
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.
Please see the repository issues. You are welcome to submit new issues.
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