]> git.saurik.com Git - redis.git/blame - src/redis-cli.c
TODO updated
[redis.git] / src / redis-cli.c
CommitLineData
ed9b544e 1/* Redis CLI (command line interface)
2 *
12d090d2 3 * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
ed9b544e 4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
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.
17 *
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.
29 */
30
23d4709d 31#include "fmacros.h"
185cabda 32#include "version.h"
23d4709d 33
ed9b544e 34#include <stdio.h>
35#include <string.h>
36#include <stdlib.h>
37#include <unistd.h>
a88a2af6 38#include <ctype.h>
c0b3d423 39#include <errno.h>
b4b62c34 40#include <sys/stat.h>
3ce014c7 41#include <sys/time.h>
41945ba6 42#include <assert.h>
ed9b544e 43
7fc4ce13 44#include "hiredis.h"
ed9b544e 45#include "sds.h"
ed9b544e 46#include "zmalloc.h"
cf87ebf2 47#include "linenoise.h"
5397f2b5 48#include "help.h"
ed9b544e 49
ed9b544e 50#define REDIS_NOTUSED(V) ((void) V)
51
7fc4ce13 52static redisContext *context;
ed9b544e 53static struct config {
54 char *hostip;
55 int hostport;
7e91f971 56 char *hostsocket;
5762b7f0 57 long repeat;
18f63d8d 58 long interval;
62e920df 59 int dbnum;
5d15b520 60 int interactive;
36e5db6d 61 int shutdown;
249c3a7d 62 int monitor_mode;
63 int pubsub_mode;
43071993 64 int latency_mode;
bc63407b 65 int stdinarg; /* get last arg from stdin. (-x option) */
288799e0 66 char *auth;
65add0a3
PN
67 int raw_output; /* output mode per command */
68 sds mb_delim;
3f4eef21 69 char prompt[32];
ed9b544e 70} config;
71
a9158272 72static void usage();
11fd0c42 73char *redisGitSHA1(void);
c392edf5 74char *redisGitDirty(void);
c937aa89 75
3ce014c7 76/*------------------------------------------------------------------------------
77 * Utility functions
78 *--------------------------------------------------------------------------- */
79
80static long long mstime(void) {
81 struct timeval tv;
82 long long mst;
83
84 gettimeofday(&tv, NULL);
85 mst = ((long)tv.tv_sec)*1000;
86 mst += tv.tv_usec/1000;
87 return mst;
88}
89
3f4eef21
PN
90static void cliRefreshPrompt(void) {
91 if (config.dbnum == 0)
a45f9a1a 92 snprintf(config.prompt,sizeof(config.prompt),"redis %s:%d> ",
93 config.hostip, config.hostport);
3f4eef21 94 else
a45f9a1a 95 snprintf(config.prompt,sizeof(config.prompt),"redis %s:%d[%d]> ",
96 config.hostip, config.hostport, config.dbnum);
3f4eef21
PN
97}
98
a2a69d58
PN
99/*------------------------------------------------------------------------------
100 * Help functions
101 *--------------------------------------------------------------------------- */
102
b2cc45bf
PN
103#define CLI_HELP_COMMAND 1
104#define CLI_HELP_GROUP 2
105
106typedef struct {
107 int type;
108 int argc;
109 sds *argv;
110 sds full;
111
112 /* Only used for help on commands */
113 struct commandHelp *org;
114} helpEntry;
115
116static helpEntry *helpEntries;
117static int helpEntriesLen;
118
c392edf5
PN
119static sds cliVersion() {
120 sds version;
121 version = sdscatprintf(sdsempty(), "%s", REDIS_VERSION);
122
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, ")");
129 }
130 return version;
131}
132
b2cc45bf
PN
133static void cliInitHelp() {
134 int commandslen = sizeof(commandHelp)/sizeof(struct commandHelp);
135 int groupslen = sizeof(commandGroups)/sizeof(char*);
136 int i, len, pos = 0;
137 helpEntry tmp;
138
139 helpEntriesLen = len = commandslen+groupslen;
140 helpEntries = malloc(sizeof(helpEntry)*len);
141
142 for (i = 0; i < groupslen; i++) {
143 tmp.argc = 1;
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;
148 tmp.org = NULL;
149 helpEntries[pos++] = tmp;
150 }
151
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;
158 }
159}
160
a2a69d58 161/* Output command help to stdout. */
41945ba6
PN
162static 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);
166 if (group) {
167 printf(" \x1b[33mgroup:\x1b[0m %s\r\n", commandGroups[help->group]);
168 }
a2a69d58
PN
169}
170
41945ba6
PN
171/* Print generic help. */
172static void cliOutputGenericHelp() {
c392edf5 173 sds version = cliVersion();
41945ba6
PN
174 printf(
175 "redis-cli %s\r\n"
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",
c392edf5 180 version
41945ba6 181 );
c392edf5 182 sdsfree(version);
a2a69d58
PN
183}
184
185/* Output all command help, filtering by group or command name. */
41945ba6 186static void cliOutputHelp(int argc, char **argv) {
b2cc45bf 187 int i, j, len;
41945ba6 188 int group = -1;
b2cc45bf
PN
189 helpEntry *entry;
190 struct commandHelp *help;
a2a69d58 191
41945ba6
PN
192 if (argc == 0) {
193 cliOutputGenericHelp();
a2a69d58 194 return;
41945ba6
PN
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) {
199 group = i;
200 break;
201 }
202 }
a2a69d58
PN
203 }
204
41945ba6 205 assert(argc > 0);
b2cc45bf
PN
206 for (i = 0; i < helpEntriesLen; i++) {
207 entry = &helpEntries[i];
208 if (entry->type != CLI_HELP_COMMAND) continue;
209
210 help = entry->org;
a2a69d58 211 if (group == -1) {
b2cc45bf
PN
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;
216 }
217 if (j == argc) {
218 cliOutputCommandHelp(help,1);
219 }
a2a69d58
PN
220 }
221 } else {
222 if (group == help->group) {
41945ba6 223 cliOutputCommandHelp(help,0);
a2a69d58
PN
224 }
225 }
226 }
41945ba6
PN
227 printf("\r\n");
228}
229
41945ba6
PN
230static void completionCallback(const char *buf, linenoiseCompletions *lc) {
231 size_t startpos = 0;
232 int mask;
233 int i;
234 size_t matchlen;
b2cc45bf 235 sds tmp;
41945ba6
PN
236
237 if (strncasecmp(buf,"help ",5) == 0) {
238 startpos = 5;
239 while (isspace(buf[startpos])) startpos++;
b2cc45bf 240 mask = CLI_HELP_COMMAND | CLI_HELP_GROUP;
41945ba6 241 } else {
b2cc45bf 242 mask = CLI_HELP_COMMAND;
41945ba6
PN
243 }
244
b2cc45bf
PN
245 for (i = 0; i < helpEntriesLen; i++) {
246 if (!(helpEntries[i].type & mask)) continue;
41945ba6
PN
247
248 matchlen = strlen(buf+startpos);
b2cc45bf
PN
249 if (strncasecmp(buf+startpos,helpEntries[i].full,matchlen) == 0) {
250 tmp = sdsnewlen(buf,startpos);
251 tmp = sdscat(tmp,helpEntries[i].full);
41945ba6 252 linenoiseAddCompletion(lc,tmp);
b2cc45bf 253 sdsfree(tmp);
41945ba6
PN
254 }
255 }
a2a69d58
PN
256}
257
3ce014c7 258/*------------------------------------------------------------------------------
259 * Networking / parsing
260 *--------------------------------------------------------------------------- */
261
7fc4ce13
PN
262/* Send AUTH command to the server */
263static int cliAuth() {
264 redisReply *reply;
265 if (config.auth == NULL) return REDIS_OK;
266
267 reply = redisCommand(context,"AUTH %s",config.auth);
268 if (reply != NULL) {
269 freeReplyObject(reply);
270 return REDIS_OK;
271 }
272 return REDIS_ERR;
273}
274
275/* Send SELECT dbnum to the server */
276static int cliSelect() {
277 redisReply *reply;
7fc4ce13
PN
278 if (config.dbnum == 0) return REDIS_OK;
279
96e34b3c 280 reply = redisCommand(context,"SELECT %d",config.dbnum);
7fc4ce13
PN
281 if (reply != NULL) {
282 freeReplyObject(reply);
283 return REDIS_OK;
284 }
285 return REDIS_ERR;
286}
287
c0b3d423 288/* Connect to the client. If force is not zero the connection is performed
289 * even if there is already a connected socket. */
290static int cliConnect(int force) {
7fc4ce13
PN
291 if (context == NULL || force) {
292 if (context != NULL)
293 redisFree(context);
ed9b544e 294
7e91f971 295 if (config.hostsocket == NULL) {
7fc4ce13 296 context = redisConnect(config.hostip,config.hostport);
7e91f971 297 } else {
7fc4ce13 298 context = redisConnectUnix(config.hostsocket);
7e91f971 299 }
7fc4ce13
PN
300
301 if (context->err) {
7e91f971
PN
302 fprintf(stderr,"Could not connect to Redis at ");
303 if (config.hostsocket == NULL)
7fc4ce13 304 fprintf(stderr,"%s:%d: %s\n",config.hostip,config.hostport,context->errstr);
7e91f971 305 else
7fc4ce13
PN
306 fprintf(stderr,"%s: %s\n",config.hostsocket,context->errstr);
307 redisFree(context);
308 context = NULL;
309 return REDIS_ERR;
6fa24622 310 }
ed9b544e 311
7fc4ce13
PN
312 /* Do AUTH and select the right DB. */
313 if (cliAuth() != REDIS_OK)
314 return REDIS_ERR;
315 if (cliSelect() != REDIS_OK)
316 return REDIS_ERR;
ed9b544e 317 }
7fc4ce13 318 return REDIS_OK;
ed9b544e 319}
320
a45f9a1a 321static void cliPrintContextError() {
7fc4ce13
PN
322 if (context == NULL) return;
323 fprintf(stderr,"Error: %s\n",context->errstr);
ed9b544e 324}
325
65add0a3 326static sds cliFormatReplyTTY(redisReply *r, char *prefix) {
7fc4ce13
PN
327 sds out = sdsempty();
328 switch (r->type) {
329 case REDIS_REPLY_ERROR:
65add0a3 330 out = sdscatprintf(out,"(error) %s\n", r->str);
7fc4ce13
PN
331 break;
332 case REDIS_REPLY_STATUS:
7fc4ce13
PN
333 out = sdscat(out,r->str);
334 out = sdscat(out,"\n");
335 break;
336 case REDIS_REPLY_INTEGER:
65add0a3 337 out = sdscatprintf(out,"(integer) %lld\n",r->integer);
7fc4ce13
PN
338 break;
339 case REDIS_REPLY_STRING:
65add0a3
PN
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");
7fc4ce13
PN
344 break;
345 case REDIS_REPLY_NIL:
7fc4ce13
PN
346 out = sdscat(out,"(nil)\n");
347 break;
348 case REDIS_REPLY_ARRAY:
349 if (r->elements == 0) {
7fc4ce13 350 out = sdscat(out,"(empty list or set)\n");
c0b3d423 351 } else {
cfcd5d6d
PN
352 unsigned int i, idxlen = 0;
353 char _prefixlen[16];
354 char _prefixfmt[16];
355 sds _prefix;
7fc4ce13
PN
356 sds tmp;
357
cfcd5d6d
PN
358 /* Calculate chars needed to represent the largest index */
359 i = r->elements;
360 do {
361 idxlen++;
362 i /= 10;
363 } while(i);
364
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);
369
370 /* Setup prefix format for every entry */
371 snprintf(_prefixfmt,sizeof(_prefixfmt),"%%s%%%dd) ",idxlen);
372
7fc4ce13 373 for (i = 0; i < r->elements; i++) {
cfcd5d6d
PN
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);
377
378 /* Format the multi bulk entry */
65add0a3 379 tmp = cliFormatReplyTTY(r->element[i],_prefix);
7fc4ce13
PN
380 out = sdscatlen(out,tmp,sdslen(tmp));
381 sdsfree(tmp);
382 }
cfcd5d6d 383 sdsfree(_prefix);
c0b3d423 384 }
7fc4ce13 385 break;
c937aa89 386 default:
7fc4ce13
PN
387 fprintf(stderr,"Unknown reply type: %d\n", r->type);
388 exit(1);
c937aa89 389 }
7fc4ce13 390 return out;
c937aa89 391}
392
65add0a3
PN
393static sds cliFormatReplyRaw(redisReply *r) {
394 sds out = sdsempty(), tmp;
395 size_t i;
396
397 switch (r->type) {
398 case REDIS_REPLY_NIL:
399 /* Nothing... */
ecc91094 400 break;
65add0a3 401 case REDIS_REPLY_ERROR:
ecc91094 402 out = sdscatlen(out,r->str,r->len);
403 out = sdscatlen(out,"\n",1);
404 break;
65add0a3
PN
405 case REDIS_REPLY_STATUS:
406 case REDIS_REPLY_STRING:
407 out = sdscatlen(out,r->str,r->len);
ecc91094 408 break;
65add0a3
PN
409 case REDIS_REPLY_INTEGER:
410 out = sdscatprintf(out,"%lld",r->integer);
ecc91094 411 break;
65add0a3
PN
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));
417 sdsfree(tmp);
418 }
ecc91094 419 break;
65add0a3
PN
420 default:
421 fprintf(stderr,"Unknown reply type: %d\n", r->type);
422 exit(1);
423 }
424 return out;
425}
426
427static int cliReadReply(int output_raw_strings) {
8ce39260 428 void *_reply;
7fc4ce13
PN
429 redisReply *reply;
430 sds out;
431
8ce39260 432 if (redisGetReply(context,&_reply) != REDIS_OK) {
7fc4ce13
PN
433 if (config.shutdown)
434 return REDIS_OK;
435 if (config.interactive) {
436 /* Filter cases where we should reconnect */
437 if (context->err == REDIS_ERR_IO && errno == ECONNRESET)
438 return REDIS_ERR;
439 if (context->err == REDIS_ERR_EOF)
440 return REDIS_ERR;
441 }
a45f9a1a 442 cliPrintContextError();
443 exit(1);
7fc4ce13 444 return REDIS_ERR; /* avoid compiler warning */
62e920df 445 }
7fc4ce13 446
8ce39260 447 reply = (redisReply*)_reply;
65add0a3
PN
448 if (output_raw_strings) {
449 out = cliFormatReplyRaw(reply);
450 } else {
451 if (config.raw_output) {
452 out = cliFormatReplyRaw(reply);
453 out = sdscat(out,"\n");
454 } else {
455 out = cliFormatReplyTTY(reply,"");
456 }
457 }
7fc4ce13
PN
458 fwrite(out,sdslen(out),1,stdout);
459 sdsfree(out);
65add0a3 460 freeReplyObject(reply);
7fc4ce13 461 return REDIS_OK;
62e920df 462}
463
aab055ae 464static int cliSendCommand(int argc, char **argv, int repeat) {
37dc9e5a 465 char *command = argv[0];
7fc4ce13 466 size_t *argvlen;
65add0a3 467 int j, output_raw;
ed9b544e 468
a45f9a1a 469 if (context == NULL) return REDIS_ERR;
efcf948c 470
ecc91094 471 output_raw = 0;
472 if (!strcasecmp(command,"info") ||
473 (argc == 2 && !strcasecmp(command,"cluster") &&
474 (!strcasecmp(argv[1],"nodes") ||
3cd12b56 475 !strcasecmp(argv[1],"info"))) ||
476 (argc == 2 && !strcasecmp(command,"client") &&
477 !strcasecmp(argv[1],"list")))
478
ecc91094 479 {
480 output_raw = 1;
481 }
482
41945ba6
PN
483 if (!strcasecmp(command,"help") || !strcasecmp(command,"?")) {
484 cliOutputHelp(--argc, ++argv);
7fc4ce13 485 return REDIS_OK;
8079656a 486 }
37dc9e5a
PN
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;
ed9b544e 491
7fc4ce13
PN
492 /* Setup argument length */
493 argvlen = malloc(argc*sizeof(size_t));
494 for (j = 0; j < argc; j++)
495 argvlen[j] = sdslen(argv[j]);
a2f4f871 496
aab055ae 497 while(repeat--) {
7fc4ce13 498 redisAppendCommandArgv(context,argc,(const char**)argv,argvlen);
249c3a7d 499 while (config.monitor_mode) {
65add0a3 500 if (cliReadReply(output_raw) != REDIS_OK) exit(1);
d9d8ccab 501 fflush(stdout);
621d5c19 502 }
503
249c3a7d 504 if (config.pubsub_mode) {
65add0a3
PN
505 if (!config.raw_output)
506 printf("Reading messages... (press Ctrl-C to quit)\n");
249c3a7d 507 while (1) {
65add0a3 508 if (cliReadReply(output_raw) != REDIS_OK) exit(1);
249c3a7d 509 }
510 }
511
33753a73
PN
512 if (cliReadReply(output_raw) != REDIS_OK) {
513 free(argvlen);
7fc4ce13 514 return REDIS_ERR;
96e34b3c
PN
515 } else {
516 /* Store database number when SELECT was successfully executed. */
3f4eef21 517 if (!strcasecmp(command,"select") && argc == 2) {
96e34b3c 518 config.dbnum = atoi(argv[1]);
3f4eef21
PN
519 cliRefreshPrompt();
520 }
33753a73 521 }
18f63d8d 522 if (config.interval) usleep(config.interval);
523 fflush(stdout); /* Make it grep friendly */
ed9b544e 524 }
33753a73
PN
525
526 free(argvlen);
7fc4ce13 527 return REDIS_OK;
ed9b544e 528}
529
3ce014c7 530/*------------------------------------------------------------------------------
531 * User interface
532 *--------------------------------------------------------------------------- */
533
ed9b544e 534static int parseOptions(int argc, char **argv) {
535 int i;
536
537 for (i = 1; i < argc; i++) {
538 int lastarg = i==argc-1;
6cf5882c 539
ed9b544e 540 if (!strcmp(argv[i],"-h") && !lastarg) {
efcf948c 541 sdsfree(config.hostip);
542 config.hostip = sdsnew(argv[i+1]);
ed9b544e 543 i++;
a9158272 544 } else if (!strcmp(argv[i],"-h") && lastarg) {
545 usage();
f18e059e
PN
546 } else if (!strcmp(argv[i],"--help")) {
547 usage();
bc63407b 548 } else if (!strcmp(argv[i],"-x")) {
549 config.stdinarg = 1;
ed9b544e 550 } else if (!strcmp(argv[i],"-p") && !lastarg) {
551 config.hostport = atoi(argv[i+1]);
552 i++;
7e91f971
PN
553 } else if (!strcmp(argv[i],"-s") && !lastarg) {
554 config.hostsocket = argv[i+1];
555 i++;
5762b7f0 556 } else if (!strcmp(argv[i],"-r") && !lastarg) {
557 config.repeat = strtoll(argv[i+1],NULL,10);
558 i++;
18f63d8d 559 } else if (!strcmp(argv[i],"-i") && !lastarg) {
560 double seconds = atof(argv[i+1]);
561 config.interval = seconds*1000000;
562 i++;
62e920df 563 } else if (!strcmp(argv[i],"-n") && !lastarg) {
564 config.dbnum = atoi(argv[i+1]);
565 i++;
fdfdae0f 566 } else if (!strcmp(argv[i],"-a") && !lastarg) {
288799e0 567 config.auth = argv[i+1];
fdfdae0f 568 i++;
65add0a3
PN
569 } else if (!strcmp(argv[i],"--raw")) {
570 config.raw_output = 1;
43071993 571 } else if (!strcmp(argv[i],"--latency")) {
572 config.latency_mode = 1;
28c07c7b
PN
573 } else if (!strcmp(argv[i],"-d") && !lastarg) {
574 sdsfree(config.mb_delim);
575 config.mb_delim = sdsnew(argv[i+1]);
576 i++;
f18e059e
PN
577 } else if (!strcmp(argv[i],"-v") || !strcmp(argv[i], "--version")) {
578 sds version = cliVersion();
579 printf("redis-cli %s\n", version);
580 sdsfree(version);
185cabda 581 exit(0);
ed9b544e 582 } else {
583 break;
584 }
585 }
586 return i;
587}
588
589static sds readArgFromStdin(void) {
590 char buf[1024];
591 sds arg = sdsempty();
592
593 while(1) {
594 int nread = read(fileno(stdin),buf,1024);
595
596 if (nread == 0) break;
597 else if (nread == -1) {
598 perror("Reading from standard input");
599 exit(1);
600 }
601 arg = sdscatlen(arg,buf,nread);
602 }
603 return arg;
604}
605
a9158272 606static void usage() {
f18e059e
PN
607 sds version = cliVersion();
608 fprintf(stderr,
609"redis-cli %s\n"
610"\n"
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"
18f63d8d 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"
f18e059e
PN
619" -n <db> Database number\n"
620" -x Read last argument from STDIN\n"
28c07c7b 621" -d <delimiter> Multi-bulk delimiter in for raw formatting (default: \\n)\n"
65add0a3 622" --raw Use raw formatting for replies (default when STDOUT is not a tty)\n"
43071993 623" --latency Enter a special mode continuously sampling latency.\n"
f18e059e
PN
624" --help Output this help and exit\n"
625" --version Output version and exit\n"
626"\n"
627"Examples:\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"
18f63d8d 631" redis-cli -r 100 -i 1 info | grep used_memory_human:\n"
f18e059e
PN
632"\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"
635"\n",
636 version);
637 sdsfree(version);
a9158272 638 exit(1);
639}
640
6cf5882c
MMDJ
641/* Turn the plain C strings into Sds strings */
642static char **convertToSds(int count, char** args) {
643 int j;
37dc9e5a 644 char **sds = zmalloc(sizeof(char*)*count);
6cf5882c
MMDJ
645
646 for(j = 0; j < count; j++)
647 sds[j] = sdsnew(args[j]);
648
649 return sds;
650}
651
a88a2af6 652#define LINE_BUFLEN 4096
6cf5882c 653static void repl() {
ca36b4ab
PN
654 sds historyfile = NULL;
655 int history = 0;
cbce5171 656 char *line;
ca36b4ab 657 int argc;
cbce5171 658 sds *argv;
6cf5882c 659
5d15b520 660 config.interactive = 1;
41945ba6 661 linenoiseSetCompletionCallback(completionCallback);
ce260f73 662
ca36b4ab
PN
663 /* Only use history when stdin is a tty. */
664 if (isatty(fileno(stdin))) {
665 history = 1;
666
667 if (getenv("HOME") != NULL) {
668 historyfile = sdscatprintf(sdsempty(),"%s/.rediscli_history",getenv("HOME"));
669 linenoiseHistoryLoad(historyfile);
670 }
671 }
672
3f4eef21
PN
673 cliRefreshPrompt();
674 while((line = linenoise(context ? config.prompt : "not connected> ")) != NULL) {
cf87ebf2 675 if (line[0] != '\0') {
cbce5171 676 argv = sdssplitargs(line,&argc);
ca36b4ab
PN
677 if (history) linenoiseHistoryAdd(line);
678 if (historyfile) linenoiseHistorySave(historyfile);
679
0439d792
PN
680 if (argv == NULL) {
681 printf("Invalid argument(s)\n");
682 continue;
683 } else if (argc > 0) {
a88a2af6 684 if (strcasecmp(argv[0],"quit") == 0 ||
685 strcasecmp(argv[0],"exit") == 0)
c0b3d423 686 {
687 exit(0);
efcf948c 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]);
692 cliConnect(1);
bbac56c2 693 } else if (argc == 1 && !strcasecmp(argv[0],"clear")) {
694 linenoiseClearScreen();
c0b3d423 695 } else {
3ce014c7 696 long long start_time = mstime(), elapsed;
4d19e344 697 int repeat, skipargs = 0;
c0b3d423 698
4d19e344 699 repeat = atoi(argv[0]);
700 if (repeat) {
701 skipargs = 1;
702 } else {
703 repeat = 1;
704 }
705
706 if (cliSendCommand(argc-skipargs,argv+skipargs,repeat)
707 != REDIS_OK)
708 {
efcf948c 709 cliConnect(1);
7fc4ce13 710
4d19e344 711 /* If we still cannot send the command print error.
712 * We'll try to reconnect the next time. */
442c748d 713 if (cliSendCommand(argc-skipargs,argv+skipargs,repeat)
714 != REDIS_OK)
a45f9a1a 715 cliPrintContextError();
c0b3d423 716 }
3ce014c7 717 elapsed = mstime()-start_time;
339b9dc2
PN
718 if (elapsed >= 500) {
719 printf("(%.2fs)\n",(double)elapsed/1000);
720 }
c0b3d423 721 }
a88a2af6 722 }
723 /* Free the argument vector */
ca36b4ab 724 while(argc--) sdsfree(argv[argc]);
8ff6a48b 725 zfree(argv);
6cf5882c 726 }
a88a2af6 727 /* linenoise() returns malloc-ed lines like readline() */
cf87ebf2 728 free(line);
6cf5882c 729 }
6cf5882c
MMDJ
730 exit(0);
731}
732
b4b62c34
PN
733static int noninteractive(int argc, char **argv) {
734 int retval = 0;
bc63407b 735 if (config.stdinarg) {
b4b62c34
PN
736 argv = zrealloc(argv, (argc+1)*sizeof(char*));
737 argv[argc] = readArgFromStdin();
738 retval = cliSendCommand(argc+1, argv, config.repeat);
739 } else {
740 /* stdin is probably a tty, can be tested with S_ISCHR(s.st_mode) */
741 retval = cliSendCommand(argc, argv, config.repeat);
742 }
743 return retval;
744}
745
43071993 746static void latencyMode(void) {
747 redisReply *reply;
748 long long start, latency, min, max, tot, count = 0;
749 double avg;
750
751 if (!context) exit(1);
752 while(1) {
753 start = mstime();
754 reply = redisCommand(context,"PING");
755 if (reply == NULL) {
756 fprintf(stderr,"\nI/O error\n");
757 exit(1);
758 }
759 latency = mstime()-start;
760 freeReplyObject(reply);
761 count++;
762 if (count == 1) {
763 min = max = tot = latency;
764 avg = (double) latency;
765 } else {
766 if (latency < min) min = latency;
767 if (latency > max) max = latency;
96674b6d 768 tot += latency;
43071993 769 avg = (double) tot/count;
770 }
771 printf("\x1b[0G\x1b[2Kmin: %lld, max: %lld, avg: %.2f (%lld samples)",
772 min, max, avg, count);
773 fflush(stdout);
774 usleep(10000);
775 }
776}
777
ed9b544e 778int main(int argc, char **argv) {
6cf5882c 779 int firstarg;
ed9b544e 780
efcf948c 781 config.hostip = sdsnew("127.0.0.1");
ed9b544e 782 config.hostport = 6379;
7e91f971 783 config.hostsocket = NULL;
5762b7f0 784 config.repeat = 1;
18f63d8d 785 config.interval = 0;
62e920df 786 config.dbnum = 0;
5d15b520 787 config.interactive = 0;
36e5db6d 788 config.shutdown = 0;
249c3a7d 789 config.monitor_mode = 0;
790 config.pubsub_mode = 0;
43071993 791 config.latency_mode = 0;
bc63407b 792 config.stdinarg = 0;
288799e0 793 config.auth = NULL;
65add0a3
PN
794 config.raw_output = !isatty(fileno(stdout)) && (getenv("FAKETTY") == NULL);
795 config.mb_delim = sdsnew("\n");
41945ba6 796 cliInitHelp();
99628c1a 797
ed9b544e 798 firstarg = parseOptions(argc,argv);
799 argc -= firstarg;
800 argv += firstarg;
ed9b544e 801
43071993 802 /* Start in latency mode if appropriate */
803 if (config.latency_mode) {
804 cliConnect(0);
805 latencyMode();
806 }
807
abb731e5 808 /* Start interactive mode when no command is provided */
a45f9a1a 809 if (argc == 0) {
810 /* Note that in repl mode we don't abort on connection error.
811 * A new attempt will be performed for every command send. */
812 cliConnect(0);
813 repl();
814 }
815
b4b62c34 816 /* Otherwise, we have some arguments to execute */
a45f9a1a 817 if (cliConnect(0) != REDIS_OK) exit(1);
b4b62c34 818 return noninteractive(argc,convertToSds(argc,argv));
ed9b544e 819}