Skip to main content

Terminal Client for Redis with AutoCompletion and Syntax Highlighting.

Project description

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.

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

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

Uploaded Source

Built Distribution

iredis-0.1.19-py3-none-any.whl (31.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for iredis-0.1.19.tar.gz
Algorithm Hash digest
SHA256 7eb574e4c28463c30b76bc871db849a4df18dd4da5c4a80f3fa40d4d3ecb0850
MD5 8ac253a4a88752315b2fdf64133335e3
BLAKE2b-256 ce1c18bed4810a0e45fc84531df3ed8b9a07b033f18911be7e5c611101622ba7

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for iredis-0.1.19-py3-none-any.whl
Algorithm Hash digest
SHA256 d134607da2f36dc1170fcf8dd5a8620d0a5257987363b0c7d1dd118f95612c61
MD5 2e87334720871fb8032733ab8f148b4a
BLAKE2b-256 ef90126d27ffcf2a849c8337552fe6e9ec564ab344b0ff9ca565b34d2931b0ef

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