Metadata-Version: 2.1
Name: redis-viewer
Version: 0.1.1
Summary: A lightweight, cross-platform desktop GUI for Redis
Home-page: https://github.com/isee15/redis_viewer
Author: 乖猫记账
Author-email: meizhitu@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Database :: Front-Ends
Classifier: Environment :: X11 Applications :: Qt
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyQt6
Requires-Dist: redis>=4.5

# PyQt Redis Viewer
Redis 可视化客户端工具

A simple, lightweight, cross-platform desktop GUI for browsing and managing Redis.

This app is built with Python and PyQt6. It provides a user-friendly UI for typical Redis operations: scanning keys, viewing/editing values, running commands, and inspecting server info. It is minimal and portable, with few dependencies.

---
<img width="1942" height="1136" alt="image" src="https://github.com/user-attachments/assets/6826b523-7294-4ed5-a030-eab1ff1dd906" />


## ✨ Features

- Flexible connectivity
  - Host/Port/DB selection
  - SSL/TLS, optional certificate verification
  - ACL authentication (username/password)
- Keys browser
  - Pattern scan with type filter and pagination
  - Keys list with context menu (open/copy/ttl/expire/delete)
- Key editor for common types
  - string, hash, list, set, zset
  - Get/Set/Delete/TTL/Expire
- Command console
  - Quick actions (INFO, DBSIZE, CLIENT LIST, etc.)
  - Execute custom Redis commands (Ctrl+Enter)
- Results display
  - Switch between JSON Text and Tree View, supports copy
- Session persistence
  - Saves connection profiles and last scan pattern to a config file

---

## 🛠️ Installation

Install from PyPI:

```bash
pip install redis-viewer
```

Run the application:

```bash
redis-viewer
```

### Run from source

```bash
pip install PyQt6 redis
python redis_gui.py
```

---

## 🚀 Usage

1) Connection panel
- Set Host, Port, DB
- Enable SSL/TLS (optional), and toggle certificate verification as needed
- Enable Authentication if required and fill in username/password
- Click “🔌 Test” to verify connectivity

2) Keys tab
- Enter a pattern (e.g., *) and optional type filter
- Click Scan; use Next ▶ to paginate results
- Double-click a key or use the context menu to open/copy/ttl/expire/delete

3) Key Editor tab
- Choose type: string/hash/list/set/zset
- Get/Set/Delete the key; check TTL or set Expire seconds
- “Format JSON” helps format JSON text for complex structures

4) Command Console tab
- Use quick actions or type a custom Redis command
- Press Execute or Ctrl+Enter to run

5) Results
- Switch display between JSON Text and Tree View; right-click or Ctrl+C to copy

---

## ⚙️ Configuration

- Config path: `~/.redis_viewer_config.json`
- Stores connection profiles and last scan pattern
- Note: password is saved in plain text; for dev/test use only

---

## 📜 License

MIT License. See `LICENSE`.
