iredis


Nameiredis JSON
Version 1.15.0 PyPI version JSON
download
home_pagehttps://github.com/laixintao/iredis
SummaryTerminal client for Redis with auto-completion and syntax highlighting.
upload_time2024-04-15 09:20:08
maintainerNone
docs_urlNone
authorlaixintao
requires_python<4.0,>=3.8
licenseBSD-3-Clause
keywords redis key-value store commandline tools redis client
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center">
  <img width="100" height="100" src="https://raw.githubusercontent.com/laixintao/iredis/master/docs/assets/logo.png" />
</p>

<h3 align="center">Interactive Redis: A Cli for Redis with AutoCompletion and Syntax Highlighting.</h3>

<p align="center">
<a href="https://github.com/laixintao/iredis/actions"><img src="https://github.com/laixintao/iredis/workflows/Test/badge.svg" alt="Github Action"></a>
<a href="https://badge.fury.io/py/iredis"><img src="https://badge.fury.io/py/iredis.svg" alt="PyPI version"></a>
<img src="https://badgen.net/badge/python/3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11" alt="Python version">
<a href="https://pepy.tech/project/iredis"><img src="https://pepy.tech/badge/iredis" alt="Download stats"></a>
</p>

<p align="center">
  <img src="./docs/assets/demo.svg" alt="demo">
</p>

IRedis is a terminal client for redis with auto-completion and syntax
highlighting. IRedis lets you type Redis commands smoothly, and displays results
in a user-friendly format.

IRedis is an alternative for redis-cli. In most cases, IRedis behaves exactly
the same as redis-cli. Besides, it is safer to use IRedis on production servers
than redis-cli: IRedis will prevent accidentally running dangerous commands,
like `KEYS *` (see
[Redis docs / Latency generated by slow commands](https://redis.io/topics/latency#latency-generated-by-slow-commands)).

## Features

- Advanced code completion. If you run command `KEYS` then run `DEL`, IRedis
  will auto-complete your command based on `KEYS` result.
- Command validation. IRedis will validate command while you are typing, and
  highlight errors. E.g. try `CLUSTER MEET IP PORT`, IRedis will validate IP and
  PORT for you.
- Command highlighting, fully based on redis grammar. Any valid command in
  IRedis shell is a valid redis command.
- Human-friendly result display.
- _pipeline_ feature, you can use your favorite shell tools to parse redis'
  response, like `get json | jq .`.
- Support pager for long output.
- Support connection via URL, `iredis --url redis://example.com:6379/1`.
- Support cluster, IRedis will auto reissue command for `MOVED` response in
  cluster mode.
- Store server configuration: `iredis -d prod-redis` (see [dsn](#using-dsn) for
  more).
- `peek` command to check the key's type then automatically call
  `get`/`lrange`/`sscan`, etc, depending on types. You don't need to call the
  `type` command then type another command to get the value. `peek` will also
  display the key's length and memory usage.
- <kbd>Ctrl</kbd> + <kbd>C</kbd> to cancel the current typed command, this won't
  exit IRedis, exactly like bash behaviour. Use <kbd>Ctrl</kbd> + <kbd>D</kbd>
  to send a EOF to exit IRedis.
- <kbd>Ctrl</kbd> + <kbd>R</kbd> to open **reverse-i-search** to search through
  your command history.
- Auto suggestions. (Like [fish shell](http://fishshell.com/).)
- Support `--encode=utf-8`, to decode Redis' bytes responses.
- Command hint on bottom, include command syntax, supported redis version, and
  time complexity.
- Official docs with built-in `HELP` command, try `HELP SET`!
- Written in pure Python, but IRedis was packaged into a single binary with
  [PyOxidizer](https://github.com/indygreg/PyOxidizer), you can use cURL to
  download and run, it just works, even you don't have a Python interpreter.
- You can change the cli prompt using `--prompt` option or set via `~/.iredisrc`
  config file.
- Hide password for `AUTH` command.
- Says "Goodbye!" to you when you exit!
- For full features, please see: [iredis.xbin.io](https://www.iredis.xbin.io)

## Install

### Pip

Install via pip:

```
pip install iredis
```

[pipx](https://github.com/pipxproject/pipx) is recommended:

```
pipx install iredis
```

### Brew

For Mac users, you can install iredis via brew 🍻

```
brew install iredis
```

### Linux

You can also use your Linux package manager to install IRedis, like `apt` in
Ubuntu (Only available on Ubuntu 21.04+).

```shell
apt install iredis
```

[![Packaging status](https://repology.org/badge/vertical-allrepos/iredis.svg)](https://repology.org/project/iredis/versions)

### Download Binary

Or you can download the executable binary with cURL(or wget), untar, then run.
It is especially useful when you don't have a python interpreter(E.g. the
[official Redis docker image](https://hub.docker.com/_/redis/) which doesn't
have Python installed.):

```
wget  https://github.com/laixintao/iredis/releases/latest/download/iredis.tar.gz \
 && tar -xzf iredis.tar.gz \
 && ./iredis
```

(Check the [release page](https://github.com/laixintao/iredis/releases) if you
want to download an old version of IRedis.)

## Usage

Once you install IRedis, you will know how to use it. Just remember, IRedis
supports similar options like redis-cli, like `-h` for redis-server's host and
`-p` for port.

```
$ iredis --help

Usage: iredis [OPTIONS] [CMD]...

  IRedis: Interactive Redis

  When no command is given, IRedis starts in interactive mode.

  Examples:
    - iredis
    - iredis -d dsn
    - iredis -h 127.0.0.1 -p 6379
    - iredis -h 127.0.0.1 -p 6379 -a <password>
    - iredis --url redis://localhost:7890/3

  Type "help" in interactive mode for information on available commands and
  settings.

Options:
  -h TEXT                         Server hostname (default: 127.0.0.1).
  -p TEXT                         Server port (default: 6379).
  -s, --socket TEXT               Server socket (overrides hostname and port).
  -n INTEGER                      Database number.(overwrites dsn/url's db
                                  number)

  -u, --username TEXT             User name used to auth, will be ignore for
                                  redis version < 6.

  -a, --password TEXT             Password to use when connecting to the
                                  server.

  --url TEXT                      Use Redis URL to indicate connection(Can set
                                  with env `IREDIS_URL`), Example:     redis:/
                                  /[[username]:[password]]@localhost:6379/0
                                  rediss://[[username]:[password]]@localhost:6
                                  379/0     unix://[[username]:[password]]@/pa
                                  th/to/socket.sock?db=0

  -d, --dsn TEXT                  Use DSN configured into the [alias_dsn]
                                  section of iredisrc file. (Can set with env
                                  `IREDIS_DSN`)

  --newbie / --no-newbie          Show command hints and useful helps.
  --iredisrc TEXT                 Config file for iredis, default is
                                  ~/.iredisrc.

  --decode TEXT                   decode response, default is No decode, which
                                  will output all bytes literals.

  --client_name TEXT              Assign a name to the current connection.
  --raw / --no-raw                Use raw formatting for replies (default when
                                  STDOUT is not a tty). However, you can use
                                  --no-raw to force formatted output even when
                                  STDOUT is not a tty.

  --rainbow / --no-rainbow        Display colorful prompt.
  --shell / --no-shell            Allow to run shell commands, default to
                                  True.

  --pager / --no-pager            Using pager when output is too tall for your
                                  window, default to True.

  --verify-ssl [none|optional|required]
                                  Set the TLS certificate verification
                                  strategy

  --prompt TEXT                   Prompt format (supported interpolations:
                                  {client_name}, {db}, {host}, {path}, {port},
                                  {username}, {client_addr}, {client_id}).

  --version                       Show the version and exit.
  --help                          Show this message and exit.

```

### Using DSN

IRedis support storing server configuration in config file. Here is a DSN
config:

```
[alias_dsn]
dev=redis://localhost:6379/4
staging=redis://username:password@staging-redis.example.com:6379/1
```

Put this in your `iredisrc` then connect via `iredis -d staging` or
`iredis -d dev`.

### Change The Default Prompt

You can change the prompt str, the default prompt is:

```shell
127.0.0.1:6379>
```

Which is rendered by `{host}:{port}[{db}]> `, you can change this via `--prompt`
option or change
[iredisrc](https://github.com/laixintao/iredis/blob/master/iredis/data/iredisrc)
config file. The prompwt string uses python string format engine, supported
interpolations:

- `{client_name}`
- `{db}`
- `{host}`
- `{path}`
- `{port}`
- `{username}`
- `{client_addr}`
- `{client_id}`

The `--prompt` utilize
[Python String format engine](https://docs.python.org/3/library/string.html#formatstrings),
so as long as it is a valid string formatter, it will work( anything that
`"<your prompt>".format(...)` accepts). For example, you can limit your Redis
server host name's length to 5 by setting `--prompt` to
`iredis --prompt '{host:.5s}'`.

### Configuration

IRedis supports config files. Command-line options will always take precedence
over config. Configuration resolution from highest to lowest precedence 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.

(If you are using an old versions of IRedis, please use the config file below,
and change the version in URL):

https://raw.githubusercontent.com/laixintao/iredis/v1.0.4/iredis/data/iredisrc

### Keys

IRedis support unix/readline-style REPL keyboard shortcuts, which means keys
like <kbd>Ctrl</kbd> + <kbd>F</kbd> to forward work.

Also:

- <kbd>Ctrl</kbd> + <kbd>D</kbd> (i.e. EOF) to exit; you can also use the `exit`
  command.
- <kbd>Ctrl</kbd> + <kbd>L</kbd> to clear screen; you can also use the `clear`
  command.
- <kbd>Ctrl</kbd> + <kbd>X</kbd> <kbd>Ctrl</kbd> + <kbd>E</kbd> to open an
  editor to edit command, or <kbd>V</kbd> in vi-mode.

## Development

### Release Strategy

IRedis is built and released by `GitHub Actions`. Whenever a tag is pushed to
the `master` branch, a new release is built and uploaded to pypi.org, it's very
convenient.

Thus, we release as often as possible, so that users can always enjoy the new
features and bugfixes quickly. Any bugfix or new feature will get at least a
patch release, whereas big features will get a minor release.

### Setup Environment

IRedis favors [poetry](https://github.com/sdispater/poetry) as package
management tool. To setup a develop environment on your computer:

First, install poetry (you can do it in a python's virtualenv):

```
pip install poetry
```

Then run (which is similar to `pip install -e .`):

```
poetry install
```

**Be careful running testcases locally, it may flush you db!!!**

### Development Logs

This is a command-line tool, so we don't write logs to stdout.

You can `tail -f ~/.iredis.log` to see logs, the log is pretty clear, you can
see what actually happens from log files.

### Catch Up with Latest Redis-doc

IRedis use a git submodule to track current-up-to-date redis-doc version. To
catch up with latest:

1. Git pull in redis-doc
2. Copy doc files to `/data`: `cp -r redis-doc/commands* iredis/data`
3. Prettier
   markdown`prettier --prose-wrap always iredis/data/commands/*.md --write`
4. Check the diff, update IRedis' code if needed.

## Related Projects

- [redis-tui](https://github.com/mylxsw/redis-tui)

If you like iredis, you may also like other cli tools by
[dbcli](https://www.dbcli.com/):

- [pgcli](https://www.pgcli.com) - Postgres Client with Auto-completion and
  Syntax Highlighting
- [mycli](https://www.mycli.net) - MySQL/MariaDB/Percona Client with
  Auto-completion and Syntax Highlighting
- [litecli](https://litecli.com) - SQLite Client with Auto-completion and Syntax
  Highlighting
- [mssql-cli](https://github.com/dbcli/mssql-cli) - Microsoft SQL Server Client
  with Auto-completion and Syntax Highlighting
- [athenacli](https://github.com/dbcli/athenacli) - AWS Athena Client with
  Auto-completion and Syntax Highlighting
- [vcli](https://github.com/dbcli/vcli) - VerticaDB client
- [iredis](https://github.com/laixintao/iredis/) - Client for Redis with
  AutoCompletion and Syntax Highlighting

IRedis is build on the top of
[prompt_toolkit](https://github.com/jonathanslenders/python-prompt-toolkit), a
Python library (by [Jonathan Slenders](https://twitter.com/jonathan_s)) for
building rich commandline applications.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/laixintao/iredis",
    "name": "iredis",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": "Redis, key-value store, Commandline tools, Redis Client",
    "author": "laixintao",
    "author_email": "laixintao1995@163.com",
    "download_url": "https://files.pythonhosted.org/packages/7a/80/ac86d397fa0b931cfa0121ed23549a245e706b4b34e4bfc491bcd4123acf/iredis-1.15.0.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n  <img width=\"100\" height=\"100\" src=\"https://raw.githubusercontent.com/laixintao/iredis/master/docs/assets/logo.png\" />\n</p>\n\n<h3 align=\"center\">Interactive Redis: A Cli for Redis with AutoCompletion and Syntax Highlighting.</h3>\n\n<p align=\"center\">\n<a href=\"https://github.com/laixintao/iredis/actions\"><img src=\"https://github.com/laixintao/iredis/workflows/Test/badge.svg\" alt=\"Github Action\"></a>\n<a href=\"https://badge.fury.io/py/iredis\"><img src=\"https://badge.fury.io/py/iredis.svg\" alt=\"PyPI version\"></a>\n<img src=\"https://badgen.net/badge/python/3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11\" alt=\"Python version\">\n<a href=\"https://pepy.tech/project/iredis\"><img src=\"https://pepy.tech/badge/iredis\" alt=\"Download stats\"></a>\n</p>\n\n<p align=\"center\">\n  <img src=\"./docs/assets/demo.svg\" alt=\"demo\">\n</p>\n\nIRedis is a terminal client for redis with auto-completion and syntax\nhighlighting. IRedis lets you type Redis commands smoothly, and displays results\nin a user-friendly format.\n\nIRedis is an alternative for redis-cli. In most cases, IRedis behaves exactly\nthe same as redis-cli. Besides, it is safer to use IRedis on production servers\nthan redis-cli: IRedis will prevent accidentally running dangerous commands,\nlike `KEYS *` (see\n[Redis docs / Latency generated by slow commands](https://redis.io/topics/latency#latency-generated-by-slow-commands)).\n\n## Features\n\n- Advanced code completion. If you run command `KEYS` then run `DEL`, IRedis\n  will auto-complete your command based on `KEYS` result.\n- Command validation. IRedis will validate command while you are typing, and\n  highlight errors. E.g. try `CLUSTER MEET IP PORT`, IRedis will validate IP and\n  PORT for you.\n- Command highlighting, fully based on redis grammar. Any valid command in\n  IRedis shell is a valid redis command.\n- Human-friendly result display.\n- _pipeline_ feature, you can use your favorite shell tools to parse redis'\n  response, like `get json | jq .`.\n- Support pager for long output.\n- Support connection via URL, `iredis --url redis://example.com:6379/1`.\n- Support cluster, IRedis will auto reissue command for `MOVED` response in\n  cluster mode.\n- Store server configuration: `iredis -d prod-redis` (see [dsn](#using-dsn) for\n  more).\n- `peek` command to check the key's type then automatically call\n  `get`/`lrange`/`sscan`, etc, depending on types. You don't need to call the\n  `type` command then type another command to get the value. `peek` will also\n  display the key's length and memory usage.\n- <kbd>Ctrl</kbd> + <kbd>C</kbd> to cancel the current typed command, this won't\n  exit IRedis, exactly like bash behaviour. Use <kbd>Ctrl</kbd> + <kbd>D</kbd>\n  to send a EOF to exit IRedis.\n- <kbd>Ctrl</kbd> + <kbd>R</kbd> to open **reverse-i-search** to search through\n  your command history.\n- Auto suggestions. (Like [fish shell](http://fishshell.com/).)\n- Support `--encode=utf-8`, to decode Redis' bytes responses.\n- Command hint on bottom, include command syntax, supported redis version, and\n  time complexity.\n- Official docs with built-in `HELP` command, try `HELP SET`!\n- Written in pure Python, but IRedis was packaged into a single binary with\n  [PyOxidizer](https://github.com/indygreg/PyOxidizer), you can use cURL to\n  download and run, it just works, even you don't have a Python interpreter.\n- You can change the cli prompt using `--prompt` option or set via `~/.iredisrc`\n  config file.\n- Hide password for `AUTH` command.\n- Says \"Goodbye!\" to you when you exit!\n- For full features, please see: [iredis.xbin.io](https://www.iredis.xbin.io)\n\n## Install\n\n### Pip\n\nInstall via pip:\n\n```\npip install iredis\n```\n\n[pipx](https://github.com/pipxproject/pipx) is recommended:\n\n```\npipx install iredis\n```\n\n### Brew\n\nFor Mac users, you can install iredis via brew \ud83c\udf7b\n\n```\nbrew install iredis\n```\n\n### Linux\n\nYou can also use your Linux package manager to install IRedis, like `apt` in\nUbuntu (Only available on Ubuntu 21.04+).\n\n```shell\napt install iredis\n```\n\n[![Packaging status](https://repology.org/badge/vertical-allrepos/iredis.svg)](https://repology.org/project/iredis/versions)\n\n### Download Binary\n\nOr you can download the executable binary with cURL(or wget), untar, then run.\nIt is especially useful when you don't have a python interpreter(E.g. the\n[official Redis docker image](https://hub.docker.com/_/redis/) which doesn't\nhave Python installed.):\n\n```\nwget  https://github.com/laixintao/iredis/releases/latest/download/iredis.tar.gz \\\n && tar -xzf iredis.tar.gz \\\n && ./iredis\n```\n\n(Check the [release page](https://github.com/laixintao/iredis/releases) if you\nwant to download an old version of IRedis.)\n\n## Usage\n\nOnce you install IRedis, you will know how to use it. Just remember, IRedis\nsupports similar options like redis-cli, like `-h` for redis-server's host and\n`-p` for port.\n\n```\n$ iredis --help\n\nUsage: iredis [OPTIONS] [CMD]...\n\n  IRedis: Interactive Redis\n\n  When no command is given, IRedis starts in interactive mode.\n\n  Examples:\n    - iredis\n    - iredis -d dsn\n    - iredis -h 127.0.0.1 -p 6379\n    - iredis -h 127.0.0.1 -p 6379 -a <password>\n    - iredis --url redis://localhost:7890/3\n\n  Type \"help\" in interactive mode for information on available commands and\n  settings.\n\nOptions:\n  -h TEXT                         Server hostname (default: 127.0.0.1).\n  -p TEXT                         Server port (default: 6379).\n  -s, --socket TEXT               Server socket (overrides hostname and port).\n  -n INTEGER                      Database number.(overwrites dsn/url's db\n                                  number)\n\n  -u, --username TEXT             User name used to auth, will be ignore for\n                                  redis version < 6.\n\n  -a, --password TEXT             Password to use when connecting to the\n                                  server.\n\n  --url TEXT                      Use Redis URL to indicate connection(Can set\n                                  with env `IREDIS_URL`), Example:     redis:/\n                                  /[[username]:[password]]@localhost:6379/0\n                                  rediss://[[username]:[password]]@localhost:6\n                                  379/0     unix://[[username]:[password]]@/pa\n                                  th/to/socket.sock?db=0\n\n  -d, --dsn TEXT                  Use DSN configured into the [alias_dsn]\n                                  section of iredisrc file. (Can set with env\n                                  `IREDIS_DSN`)\n\n  --newbie / --no-newbie          Show command hints and useful helps.\n  --iredisrc TEXT                 Config file for iredis, default is\n                                  ~/.iredisrc.\n\n  --decode TEXT                   decode response, default is No decode, which\n                                  will output all bytes literals.\n\n  --client_name TEXT              Assign a name to the current connection.\n  --raw / --no-raw                Use raw formatting for replies (default when\n                                  STDOUT is not a tty). However, you can use\n                                  --no-raw to force formatted output even when\n                                  STDOUT is not a tty.\n\n  --rainbow / --no-rainbow        Display colorful prompt.\n  --shell / --no-shell            Allow to run shell commands, default to\n                                  True.\n\n  --pager / --no-pager            Using pager when output is too tall for your\n                                  window, default to True.\n\n  --verify-ssl [none|optional|required]\n                                  Set the TLS certificate verification\n                                  strategy\n\n  --prompt TEXT                   Prompt format (supported interpolations:\n                                  {client_name}, {db}, {host}, {path}, {port},\n                                  {username}, {client_addr}, {client_id}).\n\n  --version                       Show the version and exit.\n  --help                          Show this message and exit.\n\n```\n\n### Using DSN\n\nIRedis support storing server configuration in config file. Here is a DSN\nconfig:\n\n```\n[alias_dsn]\ndev=redis://localhost:6379/4\nstaging=redis://username:password@staging-redis.example.com:6379/1\n```\n\nPut this in your `iredisrc` then connect via `iredis -d staging` or\n`iredis -d dev`.\n\n### Change The Default Prompt\n\nYou can change the prompt str, the default prompt is:\n\n```shell\n127.0.0.1:6379>\n```\n\nWhich is rendered by `{host}:{port}[{db}]> `, you can change this via `--prompt`\noption or change\n[iredisrc](https://github.com/laixintao/iredis/blob/master/iredis/data/iredisrc)\nconfig file. The prompwt string uses python string format engine, supported\ninterpolations:\n\n- `{client_name}`\n- `{db}`\n- `{host}`\n- `{path}`\n- `{port}`\n- `{username}`\n- `{client_addr}`\n- `{client_id}`\n\nThe `--prompt` utilize\n[Python String format engine](https://docs.python.org/3/library/string.html#formatstrings),\nso as long as it is a valid string formatter, it will work( anything that\n`\"<your prompt>\".format(...)` accepts). For example, you can limit your Redis\nserver host name's length to 5 by setting `--prompt` to\n`iredis --prompt '{host:.5s}'`.\n\n### Configuration\n\nIRedis supports config files. Command-line options will always take precedence\nover config. Configuration resolution from highest to lowest precedence is:\n\n- _Options from command line_\n- `$PWD/.iredisrc`\n- `~/.iredisrc` (this path can be changed with `iredis --iredisrc $YOUR_PATH`)\n- `/etc/iredisrc`\n- default config in IRedis package.\n\nYou can copy the _self-explained_ default config here:\n\nhttps://raw.githubusercontent.com/laixintao/iredis/master/iredis/data/iredisrc\n\nAnd then make your own changes.\n\n(If you are using an old versions of IRedis, please use the config file below,\nand change the version in URL):\n\nhttps://raw.githubusercontent.com/laixintao/iredis/v1.0.4/iredis/data/iredisrc\n\n### Keys\n\nIRedis support unix/readline-style REPL keyboard shortcuts, which means keys\nlike <kbd>Ctrl</kbd> + <kbd>F</kbd> to forward work.\n\nAlso:\n\n- <kbd>Ctrl</kbd> + <kbd>D</kbd> (i.e. EOF) to exit; you can also use the `exit`\n  command.\n- <kbd>Ctrl</kbd> + <kbd>L</kbd> to clear screen; you can also use the `clear`\n  command.\n- <kbd>Ctrl</kbd> + <kbd>X</kbd> <kbd>Ctrl</kbd> + <kbd>E</kbd> to open an\n  editor to edit command, or <kbd>V</kbd> in vi-mode.\n\n## Development\n\n### Release Strategy\n\nIRedis is built and released by `GitHub Actions`. Whenever a tag is pushed to\nthe `master` branch, a new release is built and uploaded to pypi.org, it's very\nconvenient.\n\nThus, we release as often as possible, so that users can always enjoy the new\nfeatures and bugfixes quickly. Any bugfix or new feature will get at least a\npatch release, whereas big features will get a minor release.\n\n### Setup Environment\n\nIRedis favors [poetry](https://github.com/sdispater/poetry) as package\nmanagement tool. To setup a develop environment on your computer:\n\nFirst, install poetry (you can do it in a python's virtualenv):\n\n```\npip install poetry\n```\n\nThen run (which is similar to `pip install -e .`):\n\n```\npoetry install\n```\n\n**Be careful running testcases locally, it may flush you db!!!**\n\n### Development Logs\n\nThis is a command-line tool, so we don't write logs to stdout.\n\nYou can `tail -f ~/.iredis.log` to see logs, the log is pretty clear, you can\nsee what actually happens from log files.\n\n### Catch Up with Latest Redis-doc\n\nIRedis use a git submodule to track current-up-to-date redis-doc version. To\ncatch up with latest:\n\n1. Git pull in redis-doc\n2. Copy doc files to `/data`: `cp -r redis-doc/commands* iredis/data`\n3. Prettier\n   markdown`prettier --prose-wrap always iredis/data/commands/*.md --write`\n4. Check the diff, update IRedis' code if needed.\n\n## Related Projects\n\n- [redis-tui](https://github.com/mylxsw/redis-tui)\n\nIf you like iredis, you may also like other cli tools by\n[dbcli](https://www.dbcli.com/):\n\n- [pgcli](https://www.pgcli.com) - Postgres Client with Auto-completion and\n  Syntax Highlighting\n- [mycli](https://www.mycli.net) - MySQL/MariaDB/Percona Client with\n  Auto-completion and Syntax Highlighting\n- [litecli](https://litecli.com) - SQLite Client with Auto-completion and Syntax\n  Highlighting\n- [mssql-cli](https://github.com/dbcli/mssql-cli) - Microsoft SQL Server Client\n  with Auto-completion and Syntax Highlighting\n- [athenacli](https://github.com/dbcli/athenacli) - AWS Athena Client with\n  Auto-completion and Syntax Highlighting\n- [vcli](https://github.com/dbcli/vcli) - VerticaDB client\n- [iredis](https://github.com/laixintao/iredis/) - Client for Redis with\n  AutoCompletion and Syntax Highlighting\n\nIRedis is build on the top of\n[prompt_toolkit](https://github.com/jonathanslenders/python-prompt-toolkit), a\nPython library (by [Jonathan Slenders](https://twitter.com/jonathan_s)) for\nbuilding rich commandline applications.\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "Terminal client for Redis with auto-completion and syntax highlighting.",
    "version": "1.15.0",
    "project_urls": {
        "Homepage": "https://github.com/laixintao/iredis",
        "Repository": "https://github.com/laixintao/iredis"
    },
    "split_keywords": [
        "redis",
        " key-value store",
        " commandline tools",
        " redis client"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0ac0fcd3cae1771d3b145ec050767c322d070434f178b08c7a8ad8379babd15e",
                "md5": "82d63d0a37342ac1ed3c023a49e6f214",
                "sha256": "0c22edbe93e07bc556087d73361b30ab0c524c36b9749327eee66df4c13e35ec"
            },
            "downloads": -1,
            "filename": "iredis-1.15.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "82d63d0a37342ac1ed3c023a49e6f214",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 380649,
            "upload_time": "2024-04-15T09:20:05",
            "upload_time_iso_8601": "2024-04-15T09:20:05.288286Z",
            "url": "https://files.pythonhosted.org/packages/0a/c0/fcd3cae1771d3b145ec050767c322d070434f178b08c7a8ad8379babd15e/iredis-1.15.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7a80ac86d397fa0b931cfa0121ed23549a245e706b4b34e4bfc491bcd4123acf",
                "md5": "7f846ca115ab5057d361192bd5b05cd5",
                "sha256": "70c3c3d260c1f1a49145b3242a054ae1a5142021d49c72c199760874ab2c069c"
            },
            "downloads": -1,
            "filename": "iredis-1.15.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7f846ca115ab5057d361192bd5b05cd5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 252244,
            "upload_time": "2024-04-15T09:20:08",
            "upload_time_iso_8601": "2024-04-15T09:20:08.424509Z",
            "url": "https://files.pythonhosted.org/packages/7a/80/ac86d397fa0b931cfa0121ed23549a245e706b4b34e4bfc491bcd4123acf/iredis-1.15.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-15 09:20:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "laixintao",
    "github_project": "iredis",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "iredis"
}
        
Elapsed time: 0.32564s