Skip to main content

Terminal Client for Redis with AutoCompletion and Syntax Highlighting.

Project description

IRedis (Interactive Redis)

CircleCI PyPI version

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

Uploaded Source

Built Distribution

iredis-0.1.16-py3-none-any.whl (30.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: iredis-0.1.16.tar.gz
  • Upload date:
  • Size: 27.9 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.16.tar.gz
Algorithm Hash digest
SHA256 81678a8d637a466e3f03a0381463c1b1aa997dc5311b682ef17e2b005c943a27
MD5 80e8a070de8f387d971a465b00101c39
BLAKE2b-256 d47a98e1836777179fd480b44981d970c4942edb881da1e5155680fedd418207

See more details on using hashes here.

File details

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

File metadata

  • Download URL: iredis-0.1.16-py3-none-any.whl
  • Upload date:
  • Size: 30.2 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.16-py3-none-any.whl
Algorithm Hash digest
SHA256 4f4db9313ff59ba43167426650cde237d8741edc6f7a92c12eab8b802628e5ed
MD5 80dd0ca91e32dfa7a22d5d4af1a13093
BLAKE2b-256 86f07427a4e14dae239a47a19ed4c9d1ba106c732df00b2c93d27a00c4d9516e

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