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

Uploaded Source

Built Distribution

iredis-0.8.12-py3-none-any.whl (252.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: iredis-0.8.12.tar.gz
  • Upload date:
  • Size: 171.6 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.12.tar.gz
Algorithm Hash digest
SHA256 704d21b08961f865882496906df167e4eff8e12db9bd0359e82eef739cf4b581
MD5 2cf1d44bb30fd2dd0fce647e41ba4da6
BLAKE2b-256 1fe1980380801f45863483ce9ae6f790c642baccc74fe0d2b12b682299412a0c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: iredis-0.8.12-py3-none-any.whl
  • Upload date:
  • Size: 252.5 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.12-py3-none-any.whl
Algorithm Hash digest
SHA256 e507b03dec6c4da683e5a5c11e34e861653b256f198e0077eb1a43ea4e3303f1
MD5 1df931f837ae4d3c3c2c8f2eb499607b
BLAKE2b-256 50f23aa5b41ae02ef30ae63173ec7ce83ab81c3ca73ee600d5322d48e2e7331a

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