README

   1 Where to find complete Redis documentation?
   2 -------------------------------------------
   3
   4 This README is just a fast "quick start" document. You can find more detailed
   5 documentation here: http://redis.io/documentation
   6
   7
   8 Building Redis
   9 --------------
  10
  11 It is as simple as:
  12
  13     % make
  14
  15 Redis is just a single binary, but if you want to install it you can use
  16 the "make install" target that will copy the binary to /usr/local/bin
  17 by default. You can also use "make PREFIX=/some/other/directory install"
  18 if you wish to use a different destination.
  19
  20 You can run a 32 bit Redis binary using:
  21
  22     % make 32bit
  23
  24 After you build Redis is a good idea to test it (which require Tcl), using:
  25
  26     % make test
  27
  28
  29 Running Redis
  30 -------------
  31
  32 To run Redis with the default configuration just type:
  33
  34     % cd src
  35     % ./redis-server
  36
  37 If you want to provide your redis.conf, you have to run it using an additional
  38 parameter (the path of the configuration file):
  39
  40     % cd src
  41     % ./redis-server /path/to/redis.conf
  42
  43
  44 Playing with Redis
  45 ------------------
  46
  47 You can use redis-cli to play with Redis. Start a redis-server instance,
  48 then in another terminal try the following:
  49
  50     % cd src
  51     % ./redis-cli
  52     redis> ping
  53     PONG
  54     redis> set foo bar
  55     OK
  56     redis> get foo
  57     "bar"
  58     redis> incr mycounter
  59     (integer) 1
  60     redis> incr mycounter
  61     (integer) 2
  62     redis>
  63
  64 You can find the list of all the available commands here:
  65
  66     http://redis.io/commands
  67
  68 Enjoy!