Adding upstream version 1.13.0.upstream/1.13.0upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 355 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..11f3cb2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,355 @@
+<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.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>
+</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.io](https://www.iredis.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.