KEYDB-CLI(1)

NAME
keydb-cli - KeyDB client

SYNOPSIS
keydb-cli [ options ] [cmd [arg [arg ...]]]

DESCRIPTION
KeyDB is an open source (BSD licensed), in-memory data structure store, used as database, cache and message broker, found at https://docs.keydb.dev/ The keydb-cli command is a command line client to keydb-server.

OPTIONS

-h hostname
    Server hostname (default: 127.0.0.1).

-p port
    Server port (default: 6379).

-s socket
    Server socket (overrides hostname and port).

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

-r repeat
    Execute specified command N times.

-i interval
    When -r is used, waits interval seconds per command. It is possible to specify sub-second times like -i 0.1.

-n db
    Database number.

-x  Read last argument from STDIN.

-d delimiter
    Multi-bulk delimiter in for raw formatting (default: .

-c  Enable cluster mode (follow -ASK and -MOVED redirections).

--raw
    Use raw formatting for replies (default when STDOUT is not a tty).

--no-raw
    Force formatted output even when STDOUT is not a tty.

--csv
    Output in CSV format.

--stat
    Print rolling stats about server: mem, clients, ...

--latency
    Enter a special mode continuously sampling latency.

--latency-history
    Like --latency but tracking latency changes over time. Default time interval is 15 sec. Change it using -i.

--latency-dist
    Shows latency as a spectrum, requires xterm 256 colors. Default time interval is 1 sec. Change it using -i.

--lru-test
    Simulate a cache workload with an 80-20 distribution.

--slave
    Simulate a slave showing commands received from the master.

--rdb filename
    Transfer an RDB dump from remote server to local file.

--pipe
    Transfer raw KeyDB protocol from stdin to server.

--pipe-timeout n
    In --pipe mode, abort with error if after sending all data. no reply is received within n seconds. Default timeout: 30. Use 0 to wait forever.

--bigkeys
    Sample KeyBD keys looking for big keys.

--scan
    List all keys using the SCAN command.

--pattern pat
    Useful with --scan to specify a SCAN pattern.

--intrinsic-latency sec
    Run a test to measure intrinsic system latency. The test will run for the specified amount of seconds.

--eval file
    Send an EVAL command using the Lua script at file.

--ldb
    Used with --eval enable the KeyDB Lua debugger.

--ldb-sync-mode
    Like --ldb but uses the synchronous Lua debugger, in this mode the server is blocked and script changes are are not rolled back from the server memory.

--help
    Output this help and exit.

--version
    Output version and exit.

EXAMPLES

cat /etc/passwd | keydb-cli -x set mypasswd

keydb-cli get mypasswd

keydb-cli -r 100 lpush mylist x

keydb-cli -r 100 -i 1 info | grep used_memory_human:

keydb-cli --eval myscript.lua key1 key2 , arg1 arg2 arg3

keydb-cli --scan --pattern '*:12345*'

BUGS
See: https://docs.keydb.dev/ and https://github.com/JohnSully/KeyDB.git/issues

COPYRIGHT
Copyright © 2006-2016 Salvatore Sanfilippo Copyright © 2019- John Sully
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
*   Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
*   Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
*   Neither the name of Redis nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.