]>
git.saurik.com Git - redis.git/blob - src/redis-cli.c
1 /* Redis CLI (command line interface)
3 * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
9 * * Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 * * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * * Neither the name of Redis nor the names of its contributors may be used
15 * to endorse or promote products derived from this software without
16 * specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
47 #include "linenoise.h"
50 #define REDIS_NOTUSED(V) ((void) V)
52 static redisContext
*context
;
53 static struct config
{
65 int stdinarg
; /* get last arg from stdin. (-x option) */
67 int raw_output
; /* output mode per command */
73 char *redisGitSHA1(void);
74 char *redisGitDirty(void);
76 /*------------------------------------------------------------------------------
78 *--------------------------------------------------------------------------- */
80 static long long mstime(void) {
84 gettimeofday(&tv
, NULL
);
85 mst
= ((long)tv
.tv_sec
)*1000;
86 mst
+= tv
.tv_usec
/1000;
90 static void cliRefreshPrompt(void) {
91 if (config
.dbnum
== 0)
92 snprintf(config
.prompt
,sizeof(config
.prompt
),"redis %s:%d> ",
93 config
.hostip
, config
.hostport
);
95 snprintf(config
.prompt
,sizeof(config
.prompt
),"redis %s:%d[%d]> ",
96 config
.hostip
, config
.hostport
, config
.dbnum
);
99 /*------------------------------------------------------------------------------
101 *--------------------------------------------------------------------------- */
103 #define CLI_HELP_COMMAND 1
104 #define CLI_HELP_GROUP 2
112 /* Only used for help on commands */
113 struct commandHelp
*org
;
116 static helpEntry
*helpEntries
;
117 static int helpEntriesLen
;
119 static sds
cliVersion() {
121 version
= sdscatprintf(sdsempty(), "%s", REDIS_VERSION
);
123 /* Add git commit and working tree status when available */
124 if (strtoll(redisGitSHA1(),NULL
,16)) {
125 version
= sdscatprintf(version
, " (git:%s", redisGitSHA1());
126 if (strtoll(redisGitDirty(),NULL
,10))
127 version
= sdscatprintf(version
, "-dirty");
128 version
= sdscat(version
, ")");
133 static void cliInitHelp() {
134 int commandslen
= sizeof(commandHelp
)/sizeof(struct commandHelp
);
135 int groupslen
= sizeof(commandGroups
)/sizeof(char*);
139 helpEntriesLen
= len
= commandslen
+groupslen
;
140 helpEntries
= malloc(sizeof(helpEntry
)*len
);
142 for (i
= 0; i
< groupslen
; i
++) {
144 tmp
.argv
= malloc(sizeof(sds
));
145 tmp
.argv
[0] = sdscatprintf(sdsempty(),"@%s",commandGroups
[i
]);
146 tmp
.full
= tmp
.argv
[0];
147 tmp
.type
= CLI_HELP_GROUP
;
149 helpEntries
[pos
++] = tmp
;
152 for (i
= 0; i
< commandslen
; i
++) {
153 tmp
.argv
= sdssplitargs(commandHelp
[i
].name
,&tmp
.argc
);
154 tmp
.full
= sdsnew(commandHelp
[i
].name
);
155 tmp
.type
= CLI_HELP_COMMAND
;
156 tmp
.org
= &commandHelp
[i
];
157 helpEntries
[pos
++] = tmp
;
161 /* Output command help to stdout. */
162 static void cliOutputCommandHelp(struct commandHelp
*help
, int group
) {
163 printf("\r\n \x1b[1m%s\x1b[0m \x1b[90m%s\x1b[0m\r\n", help
->name
, help
->params
);
164 printf(" \x1b[33msummary:\x1b[0m %s\r\n", help
->summary
);
165 printf(" \x1b[33msince:\x1b[0m %s\r\n", help
->since
);
167 printf(" \x1b[33mgroup:\x1b[0m %s\r\n", commandGroups
[help
->group
]);
171 /* Print generic help. */
172 static void cliOutputGenericHelp() {
173 sds version
= cliVersion();
176 "Type: \"help @<group>\" to get a list of commands in <group>\r\n"
177 " \"help <command>\" for help on <command>\r\n"
178 " \"help <tab>\" to get a list of possible help topics\r\n"
179 " \"quit\" to exit\r\n",
185 /* Output all command help, filtering by group or command name. */
186 static void cliOutputHelp(int argc
, char **argv
) {
190 struct commandHelp
*help
;
193 cliOutputGenericHelp();
195 } else if (argc
> 0 && argv
[0][0] == '@') {
196 len
= sizeof(commandGroups
)/sizeof(char*);
197 for (i
= 0; i
< len
; i
++) {
198 if (strcasecmp(argv
[0]+1,commandGroups
[i
]) == 0) {
206 for (i
= 0; i
< helpEntriesLen
; i
++) {
207 entry
= &helpEntries
[i
];
208 if (entry
->type
!= CLI_HELP_COMMAND
) continue;
212 /* Compare all arguments */
213 if (argc
== entry
->argc
) {
214 for (j
= 0; j
< argc
; j
++) {
215 if (strcasecmp(argv
[j
],entry
->argv
[j
]) != 0) break;
218 cliOutputCommandHelp(help
,1);
222 if (group
== help
->group
) {
223 cliOutputCommandHelp(help
,0);
230 static void completionCallback(const char *buf
, linenoiseCompletions
*lc
) {
237 if (strncasecmp(buf
,"help ",5) == 0) {
239 while (isspace(buf
[startpos
])) startpos
++;
240 mask
= CLI_HELP_COMMAND
| CLI_HELP_GROUP
;
242 mask
= CLI_HELP_COMMAND
;
245 for (i
= 0; i
< helpEntriesLen
; i
++) {
246 if (!(helpEntries
[i
].type
& mask
)) continue;
248 matchlen
= strlen(buf
+startpos
);
249 if (strncasecmp(buf
+startpos
,helpEntries
[i
].full
,matchlen
) == 0) {
250 tmp
= sdsnewlen(buf
,startpos
);
251 tmp
= sdscat(tmp
,helpEntries
[i
].full
);
252 linenoiseAddCompletion(lc
,tmp
);
258 /*------------------------------------------------------------------------------
259 * Networking / parsing
260 *--------------------------------------------------------------------------- */
262 /* Send AUTH command to the server */
263 static int cliAuth() {
265 if (config
.auth
== NULL
) return REDIS_OK
;
267 reply
= redisCommand(context
,"AUTH %s",config
.auth
);
269 freeReplyObject(reply
);
275 /* Send SELECT dbnum to the server */
276 static int cliSelect() {
278 if (config
.dbnum
== 0) return REDIS_OK
;
280 reply
= redisCommand(context
,"SELECT %d",config
.dbnum
);
282 freeReplyObject(reply
);
288 /* Connect to the client. If force is not zero the connection is performed
289 * even if there is already a connected socket. */
290 static int cliConnect(int force
) {
291 if (context
== NULL
|| force
) {
295 if (config
.hostsocket
== NULL
) {
296 context
= redisConnect(config
.hostip
,config
.hostport
);
298 context
= redisConnectUnix(config
.hostsocket
);
302 fprintf(stderr
,"Could not connect to Redis at ");
303 if (config
.hostsocket
== NULL
)
304 fprintf(stderr
,"%s:%d: %s\n",config
.hostip
,config
.hostport
,context
->errstr
);
306 fprintf(stderr
,"%s: %s\n",config
.hostsocket
,context
->errstr
);
312 /* Do AUTH and select the right DB. */
313 if (cliAuth() != REDIS_OK
)
315 if (cliSelect() != REDIS_OK
)
321 static void cliPrintContextError() {
322 if (context
== NULL
) return;
323 fprintf(stderr
,"Error: %s\n",context
->errstr
);
326 static sds
cliFormatReplyTTY(redisReply
*r
, char *prefix
) {
327 sds out
= sdsempty();
329 case REDIS_REPLY_ERROR
:
330 out
= sdscatprintf(out
,"(error) %s\n", r
->str
);
332 case REDIS_REPLY_STATUS
:
333 out
= sdscat(out
,r
->str
);
334 out
= sdscat(out
,"\n");
336 case REDIS_REPLY_INTEGER
:
337 out
= sdscatprintf(out
,"(integer) %lld\n",r
->integer
);
339 case REDIS_REPLY_STRING
:
340 /* If you are producing output for the standard output we want
341 * a more interesting output with quoted characters and so forth */
342 out
= sdscatrepr(out
,r
->str
,r
->len
);
343 out
= sdscat(out
,"\n");
345 case REDIS_REPLY_NIL
:
346 out
= sdscat(out
,"(nil)\n");
348 case REDIS_REPLY_ARRAY
:
349 if (r
->elements
== 0) {
350 out
= sdscat(out
,"(empty list or set)\n");
352 unsigned int i
, idxlen
= 0;
358 /* Calculate chars needed to represent the largest index */
365 /* Prefix for nested multi bulks should grow with idxlen+2 spaces */
366 memset(_prefixlen
,' ',idxlen
+2);
367 _prefixlen
[idxlen
+2] = '\0';
368 _prefix
= sdscat(sdsnew(prefix
),_prefixlen
);
370 /* Setup prefix format for every entry */
371 snprintf(_prefixfmt
,sizeof(_prefixfmt
),"%%s%%%dd) ",idxlen
);
373 for (i
= 0; i
< r
->elements
; i
++) {
374 /* Don't use the prefix for the first element, as the parent
375 * caller already prepended the index number. */
376 out
= sdscatprintf(out
,_prefixfmt
,i
== 0 ? "" : prefix
,i
+1);
378 /* Format the multi bulk entry */
379 tmp
= cliFormatReplyTTY(r
->element
[i
],_prefix
);
380 out
= sdscatlen(out
,tmp
,sdslen(tmp
));
387 fprintf(stderr
,"Unknown reply type: %d\n", r
->type
);
393 static sds
cliFormatReplyRaw(redisReply
*r
) {
394 sds out
= sdsempty(), tmp
;
398 case REDIS_REPLY_NIL
:
401 case REDIS_REPLY_ERROR
:
402 out
= sdscatlen(out
,r
->str
,r
->len
);
403 out
= sdscatlen(out
,"\n",1);
405 case REDIS_REPLY_STATUS
:
406 case REDIS_REPLY_STRING
:
407 out
= sdscatlen(out
,r
->str
,r
->len
);
409 case REDIS_REPLY_INTEGER
:
410 out
= sdscatprintf(out
,"%lld",r
->integer
);
412 case REDIS_REPLY_ARRAY
:
413 for (i
= 0; i
< r
->elements
; i
++) {
414 if (i
> 0) out
= sdscat(out
,config
.mb_delim
);
415 tmp
= cliFormatReplyRaw(r
->element
[i
]);
416 out
= sdscatlen(out
,tmp
,sdslen(tmp
));
421 fprintf(stderr
,"Unknown reply type: %d\n", r
->type
);
427 static int cliReadReply(int output_raw_strings
) {
432 if (redisGetReply(context
,&_reply
) != REDIS_OK
) {
435 if (config
.interactive
) {
436 /* Filter cases where we should reconnect */
437 if (context
->err
== REDIS_ERR_IO
&& errno
== ECONNRESET
)
439 if (context
->err
== REDIS_ERR_EOF
)
442 cliPrintContextError();
444 return REDIS_ERR
; /* avoid compiler warning */
447 reply
= (redisReply
*)_reply
;
448 if (output_raw_strings
) {
449 out
= cliFormatReplyRaw(reply
);
451 if (config
.raw_output
) {
452 out
= cliFormatReplyRaw(reply
);
453 out
= sdscat(out
,"\n");
455 out
= cliFormatReplyTTY(reply
,"");
458 fwrite(out
,sdslen(out
),1,stdout
);
460 freeReplyObject(reply
);
464 static int cliSendCommand(int argc
, char **argv
, int repeat
) {
465 char *command
= argv
[0];
469 if (context
== NULL
) return REDIS_ERR
;
472 if (!strcasecmp(command
,"info") ||
473 (argc
== 2 && !strcasecmp(command
,"cluster") &&
474 (!strcasecmp(argv
[1],"nodes") ||
475 !strcasecmp(argv
[1],"info"))) ||
476 (argc
== 2 && !strcasecmp(command
,"client") &&
477 !strcasecmp(argv
[1],"list")))
483 if (!strcasecmp(command
,"help") || !strcasecmp(command
,"?")) {
484 cliOutputHelp(--argc
, ++argv
);
487 if (!strcasecmp(command
,"shutdown")) config
.shutdown
= 1;
488 if (!strcasecmp(command
,"monitor")) config
.monitor_mode
= 1;
489 if (!strcasecmp(command
,"subscribe") ||
490 !strcasecmp(command
,"psubscribe")) config
.pubsub_mode
= 1;
492 /* Setup argument length */
493 argvlen
= malloc(argc
*sizeof(size_t));
494 for (j
= 0; j
< argc
; j
++)
495 argvlen
[j
] = sdslen(argv
[j
]);
498 redisAppendCommandArgv(context
,argc
,(const char**)argv
,argvlen
);
499 while (config
.monitor_mode
) {
500 if (cliReadReply(output_raw
) != REDIS_OK
) exit(1);
504 if (config
.pubsub_mode
) {
505 if (!config
.raw_output
)
506 printf("Reading messages... (press Ctrl-C to quit)\n");
508 if (cliReadReply(output_raw
) != REDIS_OK
) exit(1);
512 if (cliReadReply(output_raw
) != REDIS_OK
) {
516 /* Store database number when SELECT was successfully executed. */
517 if (!strcasecmp(command
,"select") && argc
== 2) {
518 config
.dbnum
= atoi(argv
[1]);
522 if (config
.interval
) usleep(config
.interval
);
523 fflush(stdout
); /* Make it grep friendly */
530 /*------------------------------------------------------------------------------
532 *--------------------------------------------------------------------------- */
534 static int parseOptions(int argc
, char **argv
) {
537 for (i
= 1; i
< argc
; i
++) {
538 int lastarg
= i
==argc
-1;
540 if (!strcmp(argv
[i
],"-h") && !lastarg
) {
541 sdsfree(config
.hostip
);
542 config
.hostip
= sdsnew(argv
[i
+1]);
544 } else if (!strcmp(argv
[i
],"-h") && lastarg
) {
546 } else if (!strcmp(argv
[i
],"--help")) {
548 } else if (!strcmp(argv
[i
],"-x")) {
550 } else if (!strcmp(argv
[i
],"-p") && !lastarg
) {
551 config
.hostport
= atoi(argv
[i
+1]);
553 } else if (!strcmp(argv
[i
],"-s") && !lastarg
) {
554 config
.hostsocket
= argv
[i
+1];
556 } else if (!strcmp(argv
[i
],"-r") && !lastarg
) {
557 config
.repeat
= strtoll(argv
[i
+1],NULL
,10);
559 } else if (!strcmp(argv
[i
],"-i") && !lastarg
) {
560 double seconds
= atof(argv
[i
+1]);
561 config
.interval
= seconds
*1000000;
563 } else if (!strcmp(argv
[i
],"-n") && !lastarg
) {
564 config
.dbnum
= atoi(argv
[i
+1]);
566 } else if (!strcmp(argv
[i
],"-a") && !lastarg
) {
567 config
.auth
= argv
[i
+1];
569 } else if (!strcmp(argv
[i
],"--raw")) {
570 config
.raw_output
= 1;
571 } else if (!strcmp(argv
[i
],"--latency")) {
572 config
.latency_mode
= 1;
573 } else if (!strcmp(argv
[i
],"-d") && !lastarg
) {
574 sdsfree(config
.mb_delim
);
575 config
.mb_delim
= sdsnew(argv
[i
+1]);
577 } else if (!strcmp(argv
[i
],"-v") || !strcmp(argv
[i
], "--version")) {
578 sds version
= cliVersion();
579 printf("redis-cli %s\n", version
);
589 static sds
readArgFromStdin(void) {
591 sds arg
= sdsempty();
594 int nread
= read(fileno(stdin
),buf
,1024);
596 if (nread
== 0) break;
597 else if (nread
== -1) {
598 perror("Reading from standard input");
601 arg
= sdscatlen(arg
,buf
,nread
);
606 static void usage() {
607 sds version
= cliVersion();
611 "Usage: redis-cli [OPTIONS] [cmd [arg [arg ...]]]\n"
612 " -h <hostname> Server hostname (default: 127.0.0.1)\n"
613 " -p <port> Server port (default: 6379)\n"
614 " -s <socket> Server socket (overrides hostname and port)\n"
615 " -a <password> Password to use when connecting to the server\n"
616 " -r <repeat> Execute specified command N times\n"
617 " -i <interval> When -r is used, waits <interval> seconds per command.\n"
618 " It is possible to specify sub-second times like -i 0.1.\n"
619 " -n <db> Database number\n"
620 " -x Read last argument from STDIN\n"
621 " -d <delimiter> Multi-bulk delimiter in for raw formatting (default: \\n)\n"
622 " --raw Use raw formatting for replies (default when STDOUT is not a tty)\n"
623 " --latency Enter a special mode continuously sampling latency.\n"
624 " --help Output this help and exit\n"
625 " --version Output version and exit\n"
628 " cat /etc/passwd | redis-cli -x set mypasswd\n"
629 " redis-cli get mypasswd\n"
630 " redis-cli -r 100 lpush mylist x\n"
631 " redis-cli -r 100 -i 1 info | grep used_memory_human:\n"
633 "When no command is given, redis-cli starts in interactive mode.\n"
634 "Type \"help\" in interactive mode for information on available commands.\n"
641 /* Turn the plain C strings into Sds strings */
642 static char **convertToSds(int count
, char** args
) {
644 char **sds
= zmalloc(sizeof(char*)*count
);
646 for(j
= 0; j
< count
; j
++)
647 sds
[j
] = sdsnew(args
[j
]);
652 #define LINE_BUFLEN 4096
654 sds historyfile
= NULL
;
660 config
.interactive
= 1;
661 linenoiseSetCompletionCallback(completionCallback
);
663 /* Only use history when stdin is a tty. */
664 if (isatty(fileno(stdin
))) {
667 if (getenv("HOME") != NULL
) {
668 historyfile
= sdscatprintf(sdsempty(),"%s/.rediscli_history",getenv("HOME"));
669 linenoiseHistoryLoad(historyfile
);
674 while((line
= linenoise(context
? config
.prompt
: "not connected> ")) != NULL
) {
675 if (line
[0] != '\0') {
676 argv
= sdssplitargs(line
,&argc
);
677 if (history
) linenoiseHistoryAdd(line
);
678 if (historyfile
) linenoiseHistorySave(historyfile
);
681 printf("Invalid argument(s)\n");
683 } else if (argc
> 0) {
684 if (strcasecmp(argv
[0],"quit") == 0 ||
685 strcasecmp(argv
[0],"exit") == 0)
688 } else if (argc
== 3 && !strcasecmp(argv
[0],"connect")) {
689 sdsfree(config
.hostip
);
690 config
.hostip
= sdsnew(argv
[1]);
691 config
.hostport
= atoi(argv
[2]);
693 } else if (argc
== 1 && !strcasecmp(argv
[0],"clear")) {
694 linenoiseClearScreen();
696 long long start_time
= mstime(), elapsed
;
697 int repeat
, skipargs
= 0;
699 repeat
= atoi(argv
[0]);
706 if (cliSendCommand(argc
-skipargs
,argv
+skipargs
,repeat
)
711 /* If we still cannot send the command print error.
712 * We'll try to reconnect the next time. */
713 if (cliSendCommand(argc
-skipargs
,argv
+skipargs
,repeat
)
715 cliPrintContextError();
717 elapsed
= mstime()-start_time
;
718 if (elapsed
>= 500) {
719 printf("(%.2fs)\n",(double)elapsed
/1000);
723 /* Free the argument vector */
724 while(argc
--) sdsfree(argv
[argc
]);
727 /* linenoise() returns malloc-ed lines like readline() */
733 static int noninteractive(int argc
, char **argv
) {
735 if (config
.stdinarg
) {
736 argv
= zrealloc(argv
, (argc
+1)*sizeof(char*));
737 argv
[argc
] = readArgFromStdin();
738 retval
= cliSendCommand(argc
+1, argv
, config
.repeat
);
740 /* stdin is probably a tty, can be tested with S_ISCHR(s.st_mode) */
741 retval
= cliSendCommand(argc
, argv
, config
.repeat
);
746 static void latencyMode(void) {
748 long long start
, latency
, min
, max
, tot
, count
= 0;
751 if (!context
) exit(1);
754 reply
= redisCommand(context
,"PING");
756 fprintf(stderr
,"\nI/O error\n");
759 latency
= mstime()-start
;
760 freeReplyObject(reply
);
763 min
= max
= tot
= latency
;
764 avg
= (double) latency
;
766 if (latency
< min
) min
= latency
;
767 if (latency
> max
) max
= latency
;
769 avg
= (double) tot
/count
;
771 printf("\x1b[0G\x1b[2Kmin: %lld, max: %lld, avg: %.2f (%lld samples)",
772 min
, max
, avg
, count
);
778 int main(int argc
, char **argv
) {
781 config
.hostip
= sdsnew("127.0.0.1");
782 config
.hostport
= 6379;
783 config
.hostsocket
= NULL
;
787 config
.interactive
= 0;
789 config
.monitor_mode
= 0;
790 config
.pubsub_mode
= 0;
791 config
.latency_mode
= 0;
794 config
.raw_output
= !isatty(fileno(stdout
)) && (getenv("FAKETTY") == NULL
);
795 config
.mb_delim
= sdsnew("\n");
798 firstarg
= parseOptions(argc
,argv
);
802 /* Start in latency mode if appropriate */
803 if (config
.latency_mode
) {
808 /* Start interactive mode when no command is provided */
810 /* Note that in repl mode we don't abort on connection error.
811 * A new attempt will be performed for every command send. */
816 /* Otherwise, we have some arguments to execute */
817 if (cliConnect(0) != REDIS_OK
) exit(1);
818 return noninteractive(argc
,convertToSds(argc
,argv
));