Skip to content

gregk/redis_tui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Redis TUI

A terminal user interface for browsing and managing Redis data.

Features

  • Tree-based navigation of Redis keys
  • Support for all Redis data types (strings, lists, sets, hashes, sorted sets)
  • Pattern-based filtering
  • Data type filtering
  • TTL display and management
  • Basic Redis operations (view, edit, delete)
  • Search functionality
  • Configurable Redis connection

Prerequisites

Redis Installation

macOS

Using Homebrew:

brew install redis
brew services start redis

Other Platforms

Verify Redis Installation

redis-cli ping

If you see PONG as the response, Redis is running correctly!

Installation

Option 1: Install from source (recommended for development)

  1. Clone the repository:
git clone https://github.com/gregk/redis_tui.git
cd redis_tui
  1. Create and activate a virtual environment:
python3 -m venv venv
source venv/bin/activate  # On macOS/Linux
  1. Install in development mode:
pip install -e .

Option 2: Install using pip (coming soon)

pip install redis-tui

Usage

There are two ways to run Redis TUI:

  1. Using the installed command:
redis-tui
  1. Running the module directly:
python -m src.app

Connection Options

Connect to a specific Redis instance:

redis-tui --host localhost --port 6379 --db 0

Or when running as a module:

python -m src.app --host localhost --port 6379 --db 0

Load sample data for testing/demo purposes:

redis-tui --samples

Key Bindings

  • /: Navigate keys
  • /: Collapse/expand tree nodes
  • Enter: Select key
  • f: Toggle between key tree and data view
  • d: Toggle raw data view
  • q: Quit
  • r: Refresh data

Configuration

Redis connection details can be provided via:

  1. Command line arguments
  2. Environment variables:
    export REDIS_HOST=localhost
    export REDIS_PORT=6379
    export REDIS_DB=0
  3. Configuration file:
    # ~/.config/redis-tui/config.yaml
    redis:
      host: localhost
      port: 6379
      db: 0

Development Setup

  1. Clone the repository:
git clone https://github.com/yourusername/redis-tui.git
cd redis-tui
  1. Create and activate a virtual environment:
python3 -m venv venv
source venv/bin/activate  # On macOS/Linux
  1. Install development dependencies:
pip install -e ".[dev]"

Contributing

Contributions are welcome! Please see our contributing guidelines for more details.

License

MIT License

About

This is a Terminal UI (TUI) for redis to showcase the power of the textual library

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages