1
0
Fork 0

Adding upstream version 1.10.0.

Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
Daniel Baumann 2025-02-09 17:04:49 +01:00
parent c0bb48d3f7
commit e47dfcc74f
Signed by: daniel
GPG key ID: FBB4F0E80A80222F
10 changed files with 134 additions and 44 deletions

View file

@ -7,10 +7,8 @@
<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.6%20%7C%203.7%20%7C%203.8%20%7C%203.9/" alt="Python version">
<img src="https://badgen.net/badge/python/3.6%20%7C%203.7%20%7C%203.8%20%7C%203.9%20%7C%203.10/" alt="Python version">
<a href="https://pepy.tech/project/iredis"><img src="https://pepy.tech/badge/iredis" alt="Download stats"></a>
<a href="https://t.me/iredis_users"><img src="https://badgen.net/badge/icon/join?icon=telegram&amp;label=usergroup" alt="Chat on telegram"></a>
<a href="https://console.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://github.com/laixintao/iredis&amp;cloudshell_print=docs/cloudshell/run-in-docker.txt"><img src="https://badgen.net/badge/run/GoogleCloudShell/blue?icon=terminal" alt="Open in Cloud Shell"></a>
</p>
<p align="center">
@ -41,6 +39,8 @@ like `KEYS *` (see
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
@ -66,6 +66,8 @@ like `KEYS *` (see
## Install
### Pip
Install via pip:
```
@ -78,6 +80,27 @@ pip install iredis
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
@ -100,6 +123,57 @@ supports similar options like redis-cli, like `-h` for redis-server's host and
```
$ iredis --help
Usage: [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 TEXT Database number.(overwrites dsn/url's db number)
-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:6379/0
unix://[[username]:[password]]@/path/to/socket.soc
k?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.
--version Show the version and exit.
--help Show this message and exit.
```
### Using DSN