tredis - Terminal UI for Redis

tredis provides a terminal UI to interact with your Redis servers. The aim of this project is to make it easier to navigate, observe, and manage your Redis data in the wild.

Showcase

Features

• Multi-Server Support - Manage multiple Redis servers from a single interface
• TLS Support - Connect to Redis servers with TLS encryption (Upstash, Redis Cloud, etc.)
• Key Browser - Browse and search keys with pagination
• Data Type Support - View and inspect String, List, Set, Hash, ZSet, and Stream data types
• Real-time Monitoring - Monitor Redis commands in real-time
• Pub/Sub - Subscribe to channels and view messages
• Streams - Browse and consume Redis Streams
• Client List - View connected clients
• Slowlog - Inspect slow queries
• Server Info - View detailed server information with vim-style search (/, n, N)
• ACL Management - View ACL users and permissions
• Configuration - Browse and view Redis configuration
• Keyboard-Driven - Vim-like navigation and commands
• Filtering - Filter keys by pattern

Installation

Homebrew (macOS/Linux)

brew install huseyinbabal/tap/tredis

Scoop (Windows)

scoop bucket add huseyinbabal https://github.com/huseyinbabal/scoop-bucket
scoop install tredis

Download Pre-built Binaries

Download the latest release from the Releases page.

Quick Install (macOS/Linux)

# macOS Apple Silicon
curl -sL https://github.com/huseyinbabal/tredis/releases/latest/download/tredis-aarch64-apple-darwin.tar.gz | tar xz
sudo mv tredis /usr/local/bin/

# macOS Intel
curl -sL https://github.com/huseyinbabal/tredis/releases/latest/download/tredis-x86_64-apple-darwin.tar.gz | tar xz
sudo mv tredis /usr/local/bin/

# Linux x86_64
curl -sL https://github.com/huseyinbabal/tredis/releases/latest/download/tredis-x86_64-unknown-linux-gnu.tar.gz | tar xz
sudo mv tredis /usr/local/bin/

# Linux ARM64
curl -sL https://github.com/huseyinbabal/tredis/releases/latest/download/tredis-aarch64-unknown-linux-gnu.tar.gz | tar xz
sudo mv tredis /usr/local/bin/

Windows

1. Download tredis-x86_64-pc-windows-msvc.zip from the Releases page
2. Extract the zip file
3. Add the extracted folder to your PATH, or move tredis.exe to a directory in your PATH

Using Cargo

cargo install tredis

Using Docker

# Run interactively
docker run --rm -it huseyinbabal/tredis

# Connect to a specific Redis server
docker run --rm -it huseyinbabal/tredis --host redis.example.com --port 6379

# Using environment variables (recommended for containers)
docker run --rm -it \
  -e TREDIS_HOST=redis.example.com \
  -e TREDIS_PORT=6379 \
  huseyinbabal/tredis

# Build locally
docker build -t tredis .
docker run --rm -it tredis

Note: Use -it flags for interactive terminal support (required for TUI).

From Source

tredis is built with Rust. Make sure you have Rust 1.70+ installed, along with a C compiler and linker.

Build Dependencies

# Clone the repository
git clone https://github.com/huseyinbabal/tredis.git
cd tredis

# Build and run
cargo build --release
./target/release/tredis

Quick Start

# Launch tredis (will prompt to add a server if none configured)
tredis

# Launch with a specific host and port
tredis --host localhost --port 6379

# Connect to a specific database
tredis --host localhost --port 6379 --db 1

# Enable debug logging
tredis --log-level debug

CLI Options

Note: CLI arguments take precedence over environment variables. TREDIS_* prefixed variables take precedence over non-prefixed ones.

Adding a Server

When you first launch tredis, you'll be prompted to add a server. Enter:

• Name: A friendly name for the server (e.g., "production", "local")
• URI: The Redis connection URI

URI Format

redis://[[user]:password@]host[:port][/db]
rediss://[[user]:password@]host[:port][/db]  # TLS

Examples:

redis://localhost:6379                    # Local Redis
redis://localhost:6379/1                  # Local Redis, database 1
redis://:mypassword@localhost:6379        # With password
rediss://default:token@my.upstash.io:6379 # Upstash (TLS)
rediss://user:pass@redis.cloud.com:6380   # Redis Cloud (TLS)

Log File Locations

Configuration File

Server configurations are stored in:

Key Bindings

Resource Navigation

Press : to open the resource picker. Available resources:

Supported Data Types

tredis supports viewing all Redis data types:

Cloud Redis Support

tredis supports connecting to cloud Redis providers:

Note: Cloud providers typically require TLS (rediss://). Check your provider's documentation for the exact connection string format.

Known Issues

• Some Redis commands may not be available on all Redis versions
• Cluster mode is detected but individual node management is not yet supported
• Large keys may take time to load in the describe view

Contributing

Contributions are welcome! Please see our Contributing Guide for details.

Acknowledgments

• Inspired by k9s - the awesome Kubernetes CLI
• Inspired by taws - Terminal UI for AWS
• Built with Ratatui - Rust TUI library

License

This project is licensed under the MIT License - see the LICENSE file for details.

Made with ❤️ for the Redis community