Skip to main content

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

Project description

IRedis (Interactive Redis)

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

A Terminal Client for Redis with AutoCompletion and Syntax Highlighting. It is an alternative for redis-cli. IRedis is supposed to friendly for both user and redis-server, which means it is safe to use IRedis on production server. IRedis provide a --strict mode to prevent accidently running dangerous command, like KEYS *(See here, the Latency generated by slow commands section.

This project is under development, any comments are welcome.

Features

  • 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.
  • 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!

Install

pip install iredis

Usage

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:

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

And then make your own changes.

Development

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 pypi.org, 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.

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 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-0.8.9.tar.gz (41.9 kB view details)

Uploaded Source

Built Distribution

iredis-0.8.9-py3-none-any.whl (44.3 kB view details)

Uploaded Python 3

File details

Details for the file iredis-0.8.9.tar.gz.

File metadata

  • Download URL: iredis-0.8.9.tar.gz
  • Upload date:
  • Size: 41.9 kB
  • Tags: Source
  • Uploaded using 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.41.1 CPython/3.7.5

File hashes

Hashes for iredis-0.8.9.tar.gz
Algorithm Hash digest
SHA256 2b30e9cb277ff48507754dd01bfdda5a56dd39f9f60351421fc12135c3b89229
MD5 05aede3f1f1d43aacc38896e07a9d1d7
BLAKE2b-256 8cd89270d174f48e88e510b283e3a70fd9374623716cd56accc6126e70aeb6d4

See more details on using hashes here.

File details

Details for the file iredis-0.8.9-py3-none-any.whl.

File metadata

  • Download URL: iredis-0.8.9-py3-none-any.whl
  • Upload date:
  • Size: 44.3 kB
  • Tags: Python 3
  • Uploaded using 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.41.1 CPython/3.7.5

File hashes

Hashes for iredis-0.8.9-py3-none-any.whl
Algorithm Hash digest
SHA256 c51fe061871fa3113199cbd5e527e66edd26cde499a3f657c0e6fe8703200ea1
MD5 26e77dd64769a4358cebd45c8f18a1b7
BLAKE2b-256 9dd3689924cbd42183f472f28f1c45ec02cf499b5ca6cd84e1d61a1ec314d3d5

See more details on using hashes here.

Supported by

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