Heroku plugin to manage Heroku Redis
npm install @heroku-cli/plugin-redisAn Heroku CLI plugin for managing Heroku Redis instances.
Use `plugins:install to install it:
`console`
heroku plugins:install heroku-redis
CLI commands are described in the Heroku Redis devcenter article.
To publish new versions, see
the data plugin documentation.
* [heroku redis [DATABASE]](#heroku-redis-database)heroku redis:cli [DATABASE]
* [](#heroku-rediscli-database)heroku redis:credentials [DATABASE]
* [](#heroku-rediscredentials-database)heroku redis:info [DATABASE]
* [](#heroku-redisinfo-database)heroku redis:maintenance [DATABASE]
* [](#heroku-redismaintenance-database)heroku redis:maxmemory [DATABASE]
* [](#heroku-redismaxmemory-database)heroku redis:promote DATABASE
*
* [](#heroku-redistimeout-database)heroku redis:wait [DATABASE]
* [](#heroku-rediswait-database)
gets information about redis
`
USAGE
$ heroku redis [DATABASE]
OPTIONS
-a, --app=app (required) [default: heroku-cli-auth-staging] app to run command against
-r, --remote=remote git remote of app to use
`
opens a redis prompt
`
USAGE
$ heroku redis:cli [DATABASE]
OPTIONS
-a, --app=app (required) [default: heroku-cli-auth-staging] app to run command against
-c, --confirm=confirm
-r, --remote=remote git remote of app to use
`
display credentials information
`
USAGE
$ heroku redis:credentials [DATABASE]
OPTIONS
-a, --app=app (required) [default: heroku-cli-auth-staging] app to run command against
-r, --remote=remote git remote of app to use
--reset reset credentials
`
gets information about redis
`
USAGE
$ heroku redis:info [DATABASE]
OPTIONS
-a, --app=app (required) [default: heroku-cli-auth-staging] app to run command against
-r, --remote=remote git remote of app to use
`
manage maintenance windows
`
USAGE
$ heroku redis:maintenance [DATABASE]
OPTIONS
-a, --app=app (required) [default: heroku-cli-auth-staging] app to run command against
-f, --force start maintenance without entering application maintenance mode
-r, --remote=remote git remote of app to use
-w, --window=window set weekly UTC maintenance window
--run start maintenance
DESCRIPTION
Set or change the maintenance window for your Redis instance
`
set the key eviction policy
`
USAGE
$ heroku redis:maxmemory [DATABASE]
OPTIONS
-a, --app=app (required) [default: heroku-cli-auth-staging] app to run command against
-p, --policy=policy (required) set policy name
-r, --remote=remote git remote of app to use
DESCRIPTION
Set the key eviction policy when instance reaches its storage limit. Available policies for key eviction include:
noeviction # returns errors when memory limit is reached
allkeys-lru # removes less recently used keys first
volatile-lru # removes less recently used keys first that have an expiry set
allkeys-random # evicts random keys
volatile-random # evicts random keys but only those that have an expiry set
volatile-ttl # only evicts keys with an expiry set and a short TTL
`
sets DATABASE as your REDIS_URL
`
USAGE
$ heroku redis:promote DATABASE
OPTIONS
-a, --app=app (required) [default: heroku-cli-auth-staging] app to run command against
-r, --remote=remote git remote of app to use
`
set the number of seconds to wait before killing idle connections
`
USAGE
$ heroku redis:timeout [DATABASE]
OPTIONS
-a, --app=app (required) [default: heroku-cli-auth-staging] app to run command against
-r, --remote=remote git remote of app to use
-s, --seconds=seconds set timeout value
DESCRIPTION
Sets the number of seconds to wait before killing idle connections. A value of zero means that connections will not be
closed.
`
wait for Redis instance to be available
`
USAGE
$ heroku redis:wait [DATABASE]
OPTIONS
-a, --app=app (required) [default: heroku-cli-auth-staging] app to run command against
-r, --remote=remote git remote of app to use
``