Red 🔴

A TUI Redis client to inspect and manage your Redis databases. Inspired by k9s.

Installation using Homebrew

brew tap evertdespiegeleer/tap
brew install red-cli

Usage

Simply run red command, potentially providing certain configuration options.

red --connection-string="redis://localhost:6379"

Configuration

Configuration can be provided in multiple ways. In decreasing order of precedence:

1. Command line arguments
2. Environment variables
3. Configuration file
4. Built-in defaults

Command line arguments

Run red --help to see all available command line arguments.

Environment variables

• RED_CONNECTION_STRING: The Redis connection string (e.g. redis://localhost:6379)
• RED_DELIMITER: The delimiter used to group keys (default: :)

Configuration file

A configuration file can be placed either in the directory where Red is executed, or in any higher-level directory, up to your home directory. Lower level configuration files take precedence over higher-level ones. The following file names are supported:

• .redrc
• .redrc.json
• .redrc.yaml
• .redrc.yml
• .redrc.js
• .redrc.ts
• .redrc.cjs
• red.config.js
• red.config.ts
• red.config.cjs

Use the json schema as reference for the configuration file structure. Mind the version in the $schema property! Below is an example .redrc.json file:

{
    "$schema": "https://github.com/evertdespiegeleer/red-cli/releases/download/v0.0.13/redrc.schema.json",
    "connectionString": "redis://localhost:6379",
    "delimiter": ":",
    "path": "some:nested:path",
    "autoRefresh": true,
    "refreshInterval": 3000
}

Development

Initialize the repository:

./scripts/init.sh

Run the project:

bun run dev