Skip to main content

IRedis (Interactive Redis)

CircleCI PyPI version Chat on slack 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: CLUSTER MEET IP PORT
  • 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

$ iredis -h

Development

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 --develop=DEVELOP

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

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iredis-0.2.19-py3-none-any.whl (253.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: iredis-0.2.19.tar.gz
  • Upload date:
  • Size: 166.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.1

File hashes

Hashes for iredis-0.2.19.tar.gz
Algorithm Hash digest
SHA256 0361cf893c71f933df334157155f478c3c7516f5eae00708b732dcecc3d20a3e
MD5 fffb0e1760434b787fdb9cb83f585064
BLAKE2b-256 82b10dfefc65bc4e66e216741cf414a44f89b85aaae8d40f6fdeb2aecc7b80d6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: iredis-0.2.19-py3-none-any.whl
  • Upload date:
  • Size: 253.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.1

File hashes

Hashes for iredis-0.2.19-py3-none-any.whl
Algorithm Hash digest
SHA256 0b45177730b059ed622312ff6480c75363703147951cc7605c64463c0536038c
MD5 5fb3e211be05d3cb2ef5a3fd4685784c
BLAKE2b-256 92343e1e985b2dcb05dbea56a7fc7d347dff56e4d2dfeb25afff1cc6fc2babe8

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

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