redisx-cli(1)

💖 redisx-cli — a whole command-line Redis / Valkey client, bestie 💖

okay so this is the redisx-cli manual page, straight out of the RedisX Manual. it's giving "your fave terminal bestie who happens to speak fluent Redis protocol" ✨

---

✨ SYNOPSIS ✨

redisx-cli [-h hostname] [-p port] [-t timeout] [-a password]
[--user=username] [--askpass] [-r repeat [-i interval]] [-n db] [-2|-3]
[-x] [--json] [--raw] [-d delim [-D prefix]] [-c] [--tls [--sni host]
[--cacert file] [--cacertdir path] [--insecure] [--cert path --key path]
[--tls-ciphers list | --tls-ciphersuites list]] [--show-pushes=yes|no]
[--attributes] [--scan [--pattern=glob] [--count=n]] [--eval=file]
[--verbose] [--version] [--help] [--usage] [cmd [arg...]]

---

🌸 DESCRIPTION 🌸

so like. it's a completely free command-line client for Redis / Valkey servers, built on top of the RedisX library. no cap 💅

you can use it to run a command with a set of arguments on a Redis server — or, if you run it with no command argument at all, it just becomes an interactive client 🦋

redisx-cli supports many of the same options as redis-cli (1) and valkey-cli (1), and it produces similar output to those. BUT — and this is the main character plot twist — under the hood it's an entirely independent implementation of the Redis protocol. zero shared code with either Redis or Valkey. not a single line. periodt 👑

---

🎀 OPTIONS 🎀

• -h, --host=hostname — the server hostname. (default: 127.0.0.1). yes, lowercase -h means host here, keep reading, it gets spicy later 🌶️
• -p, --port=portnum — the server port. (default: 6379).
• -t, --timeout=seconds — server connection timeout, and yes you can use decimals. the default timeout is 0, which means the OS default handles it. lowkey chill of it 🧚
• -a, --pass=password — the password to use when connecting to the server.
• --user=username — used to send ACL style 'AUTH username pass'. it needs -a to work, so don't ghost your password.
• --askpass — force the user to input the password with a mask from STDIN. if this argument is used, -a will be ignored. the mask is doing the most 🙈
• -r, --repeat=n — execute the specified command n times.
• -i, --interval=seconds — when -r is used, wait this many seconds before repeating. you can absolutely specify sub-second times like -i 0.1. (default: 1).
• -n, --db=index — database number. (default 0).
• -x, --stdin — read the last argument from STDIN.
• -2, --RESP2 — start the session in RESP2 protocol mode.
• -3, --RESP3 — start the session in RESP3 protocol mode.
• --json — output in JSON format.
• --raw — use raw formatting for replies (with delimiters).
• -d, --delim=string — delimiter between elements for raw format. you can use the JSON convention for escaping special characters. (default: "\n").
• -D, --prefix=string — group prefix for raw format. you can use the JSON convention for escaping special characters. (default: "\n").
• -c, --cluster — enable cluster mode (follow -ASK and -MOVED redirections). it follows the drama wherever it goes 🔥
• --tls — establish a secure TLS connection.
• --insecure — allow an insecure TLS connection by skipping cert validation. skipping cert validation, bestie, be so serious rn 💀
• --sni=host — server name indication for TLS.
• --cacert=file — CA Certificate file to verify with.
• --cacertdir=path — directory where trusted CA certificates are stored. if neither cacert nor cacertdir are specified, the default system-wide trusted root certs configuration will apply.
• --cert=path — client certificate to authenticate with.
• --key=path — private key file to authenticate with.
• --tls-ciphers=list — sets the list of preferred ciphers (TLSv1.2 and below) in order of preference from highest to lowest, separated by colon (':').
• --tls-ciphersuites=list — sets the list of preferred ciphersuites (TLSv1.3) in order of preference from highest to lowest, separated by colon (':').
• --show-pushes=yes|no — whether to print RESP3 PUSH messages. (default: no).
• --attributes — show RESP3 attributes also, if available.
• --scan — list all keys using the SCAN command.
• --pattern=glob — keys pattern when using the --scan (default: *).
• --count=n — count option when using the --scan. (default: 10).
• --eval=file — send an EVAL command using the Lua script at file. the keyword and other arguments should be separated with a standalone comma on the command-line, such as: 'key1 key2 , arg1 arg2 ...'.
• --verbose — verbose mode.
• --version — output version and exit.
• -h, --help — show a help message, similar to this manual. (and YES, -h is also host up above — the two -h entries are both real, i don't make the rules 💅)
• --usage — display brief usage message.

---

🦋 EXIT STATUS 🦋

on a successful execution the program will return 0 🎉. in case of errors a non-zero value is returned, corresponding to an error code of the RedisX C library, and an error message and/or trace may also be printed to the standard error. so if something's wrong, check your stderr, it's yapping over there 😭

---

💜 AUTHOR 💜

Attila Kovacs <attila.kovacs[AT]cfa.harvard.edu> — icon behavior, honestly 👑

---

🌈 SEE ALSO 🌈

• redis-cli (1)
• valkey-cli (1)

---

and that's the whole page bestie, we ate and left absolutely no crumbs 🍓✨ this was version 0.9.4, dated 2024-12-15, from the RedisX Manual 💖 go forth and query something gorgeous 🫶