@mazhu/redis-cli-pro
v1.0.0
Published
A friendlier Redis management CLI tool, built with Node.js and ioredis
Downloads
130
Maintainers
Readme
🔴 Redis CLI Pro
A friendlier Redis management CLI tool built with Node.js and ioredis. Provides colored output and more intuitive commands compared to the native redis-cli.
✨ Features
- 🔍 scan - Scan keys matching a pattern
- 📊 top-keys - Show top keys by memory/size usage
- ⏱️ ttl - Get TTL (time to live) for a key
- 💾 backup - Backup all Redis data to a JSON file
- 👀 monitor - Monitor real-time Redis commands
- 🏥 health - Check Redis connection and health status
📦 Installation
npm install -g @mazhu/redis-cli-proOr use directly with npx:
npx @mazhu/redis-cli-pro health🔧 Connection Options
You can specify Redis connection via CLI options or environment variables:
| Option | Env Variable | Default |
|--------|-------------|---------|
| -h, --host | REDIS_HOST | localhost |
| -p, --port | REDIS_PORT | 6379 |
| -a, --password | REDIS_PASSWORD | - |
| -n, --db | REDIS_DB | 0 |
📖 Commands
Health Check
redis-pro health
# or
redis-pro health -h my-redis-host -p 6379Shows connection status, ping time, server version, uptime, memory usage, and key count.
Scan Keys
redis-pro scan <pattern>
redis-pro scan "user:*"
redis-pro scan "session:*" -c 500Scans keys matching the specified pattern.
Top Keys
redis-pro top-keys
redis-pro top-keys -l 20Shows top keys sorted by memory/size usage.
TTL
redis-pro ttl <key>
redis-pro ttl "session:abc123"Shows the remaining time-to-live for a key.
Backup
redis-pro backup <file>
redis-pro backup ./redis-backup.jsonExports all keys and values to a JSON file.
Monitor
redis-pro monitorShows real-time commands being executed on the Redis server.
🛠️ Development
# Clone the repo
git clone https://github.com/deepdadou/redis-cli-pro.git
cd redis-cli-pro
# Install dependencies
npm install
# Link for local testing
npm link📝 License
MIT
