diff --git a/README.md b/README.md index ea468f1..e5321cc 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,44 @@ -# Redli - a humane alternative to redis-cli +# Redli - A humane alternative to redis-cli [![Release](https://img.shields.io/github/release/IBM-Cloud/redli.svg)](https://github.com/IBM-Cloud/redli/releases/latest) ## About -Redli is a Go-based alternative to the official Redis-cli application. It's major feature is that it mimics the redis-cli command line argurments while also understanding rediss: protocols and supporting a `--tls` flag allowing it to connect to TLS/SSL secured Redis without the need for tunnels. It also has a number of flags and environment variables for passing server certificates over as files or base64 strings. Note, passing a certificate turns TLS on by default. +Redli is a Go-based alternative to the official Redis-cli application. Its major feature is that it mimics the `redis-cli` command line arguments while also understanding `redis:` protocols and supporting a `--tls` flag, allowing it to connect to TLS/SSL secured Redis without the need for tunnels. It also has a number of flags and environment variables for passing server certificates as files or base64 strings. + +_Note_: Passing a certificate turns TLS on by default. ## Installation -You can download the binary for your OS from the [releases page](https://github.com/IBM-Cloud/redli/releases). Un-tar the file, then `chmod +x` the binary and move it to your path. +### Homebrew -You can also compile Redli with **go** using these steps (Go 1.8+ required): +If you use Homebrew, run the following command to install the package: -1. `go get -u github.com/IBM-Cloud/redli` -2. `go install github.com/IBM-Cloud/redli` +`brew install redli` + +### Direct download -## Usage +You can download the binary for your OS from the [releases page](https://github.com/IBM-Cloud/redli/releases). Un-tar the file, then `chmod +x` the binary, and move it into your `$PATH`. -```text - redli [] [...] +### Compile from source - --help Show context-sensitive help (also try --help-long and --help-man). - --debug Enable debug mode. - --long Enable long prompt with host/port - -u, --uri=URI URI to connect to - -h, --host="127.0.0.1" Host to connect to - -p, --port=6379 Port to connect to - -a, --auth=AUTH Password to use when connecting - -n, --ndb=0 Redis database to access - --tls Enable TLS/SSL - --skipverify Insecure option to skip server certificate validation - --certfile=CERTFILE Self-signed certificate file for validation - --certb64=CERTB64 Self-signed certificate string as base64 for validation - --raw Produce raw output - --eval=EVAL Evaluate a Lua script file, follow with keys a , and args - -Args: - [] Redis commands and values -``` +You can also compile Redli with [Go](https://go.dev) using these steps (Go 1.8+ required): + +1. `go get -u github.com/IBM-Cloud/redli` +2. `go install github.com/IBM-Cloud/redli` -* `URI` URI to connect to. It follows the format of [the provisional IANA spec for Redis URLs](https://www.iana.org/assignments/uri-schemes/prov/redis), but with the option to denote a TLS secured connection with the protocol rediss:. +#### Usage -e.g. `INFO KEYSPACE` +Complete instructions are available in the man page (`man redli`). -Be aware of interactions with wild cards and special characters in the shell; quote and escape as appropriate. +_Note_: Be aware of interactions with wild cards and special characters in the shell; Quote and escape values as appropriate. ## License -Redli is (c) IBM Corporation 2018-2024. All rights reserved. +Redli is © IBM Corporation 2018-2024. All rights reserved. -Redli is released under the Apache 2 License. +It is available under the [Apache 2 License](https://www.apache.org/licenses/LICENSE-2.0). -Attribution: The `commands.json` file is by Salvatore Sanfillipo. +The application's build process includes the `commands.json` file from the Redis-docs repository. This file is available under a CC-BY-SA 4.0 license (see [Copyright](https://github.com/redis/docs/blob/main/LICENSE)). -In the process of building the application, the commands.json file of the Redis-docs repository is retrieved and incorporated into the code. This file is distributed under a CC-BY-SA 4.0 license (see [Copyright](https://github.com/antirez/redis-doc/blob/master/COPYRIGHT)). +Attribution: The [commands.json](https://github.com/redis/redis-doc/blob/master/commands.json) file is by [Salvatore Sanfillipo](http://invece.org).