Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add README and LICENSE

  • Loading branch information...
commit 70c7fcd69c433f7ba0e058d4a4825efd9c73640b 1 parent e2cb925
@ConradIrwin ConradIrwin authored
Showing with 73 additions and 0 deletions.
  1. +19 −0 LICENSE.MIT
  2. +54 −0 README.md
View
19 LICENSE.MIT
@@ -0,0 +1,19 @@
+Copyright (c) 2011 Conrad Irwin <conrad@rapportive.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
View
54 README.md
@@ -0,0 +1,54 @@
+A heroku plugin to talk to your redis instances on heroku.
+
+Installation
+------------
+
+Requirements:
+
+* The heroku gem — `gem install heroku`
+
+* A local installation of redis (or at least the redis-cli utility) — `apt-get install redis-server`
+
+To install:
+
+* `heroku plugins:install https://github.com/rapportive-oss/heroku-redis-cli.git`
+
+Usage
+-----
+
+* `heroku redis:info` — get run-time statistics from your redis.
+
+* `heroku redis:monitor` — monitor commands being sent to your redis in real time.
+
+* `heroku redis:cli` — execute custom commands against redis.
+
+Arguments
+---------
+
+Each command can take the heroku `--app APPNAME` parameter, and a `--db REDIS_URL` parameter (which defaults to `REDISTOGO_URL`) for selecting which redis to connect to.
+
+For `heroku redis:cli`, you can run it in interactive mode:
+
+ heroku redis:cli
+
+or specify a single command to run on the argument list:
+
+ heroku redis:cli get 10
+
+or pipe a file of redis commands.
+
+ heroku redis:cli < script.redis
+
+For any command can also specify any arguments that `redis-cli` expects. Where these conflict with information from the environment variable, the explicit options take precedence:
+
+* `-h X` — connect to redis on host named X.
+* `-p X` — connect to redis on port named X.
+* `-a X` — execute AUTH X after connecting.
+* `-n X` — execute SELECT X after connecting.
+* `-r X cmd *args` — repeat the following command X times.
+* `-v` — print out the version of redis-cli.
+
+Meta-fu
+-------
+
+This is licensed under the MIT license, contributions welcome.
Please sign in to comment.
Something went wrong with that request. Please try again.