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

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

Uploaded Source

Built Distribution

iredis-0.4.0-py3-none-any.whl (41.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for iredis-0.4.0.tar.gz
Algorithm Hash digest
SHA256 322c6380a94317da1d4989102c4313d053a108d6ebfe97d34c4d00f83e786aec
MD5 e5b815a2d9ac4e51d3c66a8f5a22b757
BLAKE2b-256 416c36ae33b1676556432ecc3e765a5643c3ef0c3aaa842ea3b8550fd22ccc36

See more details on using hashes here.

File details

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

File metadata

  • Download URL: iredis-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 41.1 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/39.0.1 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.1

File hashes

Hashes for iredis-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9efc8cc6196aaf703efcf48a81ea433a3a07d6a26df6ec2e7ebbce2dc1a71420
MD5 b06808f5c101d291fc8ded6075eb8e0e
BLAKE2b-256 78f8f47a357e3f22d091ba74258acfcdc8310d62cd2621b658f0391743854e44

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