AnotherRedisDesktopManager README

The project's README from github.com/qishibo/AnotherRedisDesktopManager. As one markdown file: README.md.

Another Redis Desktop Manager

🚀🚀🚀 A faster, better and more stable redis desktop manager, compatible with Linux, windows, mac. What's more, it won't crash when loading massive keys.


LICENSE Release Download FOSSA Status STARS

简体中文

Windows


get from microsoft store

Linux


Get it from the Snap Store

Mac

If you can't open it after installation by brew or dmg, exec the following command then reopen:
sudo xattr -rd com.apple.quarantine /Applications/Another\ Redis\ Desktop\ Manager.app


get from app store

Enjoy!

redis status dark

redis key dark

redis exec log

Contributors

This project exists thanks to all the people who contribute. contributors backers

Bruno SatoZhengchao AnBillHarry FoxTandavaWorksBWI Companies, Inc.DragonflyDBliuwei小新Mike AllisonYannick Müller

Sponsor


app store


windows store

Feature Log

Dev Build

Linux Or Mac

# clone code
git clone https://github.com/qishibo/AnotherRedisDesktopManager.git --depth=1
cd AnotherRedisDesktopManager

# install dependencies
npm install

# if download electron failed during installing, use this command
# ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/" npm install

# serve with hot reload at localhost:9988
npm start


# after the previous step is completed to 100%, open another tab, build up a desktop client
npm run electron

If linux errors like this:

# if error like this
../src/FontManagerLinux.cc:1:35: fatal error: fontconfig/fontconfig.h: No such file or directory

# then try this
sudo apt install libfontconfig1-dev

Windows

# clone code
git clone https://github.com/qishibo/AnotherRedisDesktopManager.git --depth=1
cd AnotherRedisDesktopManager

# install dependencies, 32-bit or 64-bit all use win32
npm install --platform=win32

# if download electron failed during installing, use this command
# npm config set ELECTRON_MIRROR https://npmmirror.com/mirrors/electron/
# npm install --platform=win32

# serve with hot reload at localhost:9988
npm start


# after the previous step is completed to 100%, open another tab, build up a desktop client
npm run electron

Build Package

# prepare before package
npm run pack:prepare

# build package on respective platforms
# on windows build 64bit package
npm run pack:win
# on windows build 32bit package
npm run pack:win32

# on mac
npm run pack:mac

# on linux
npm run pack:linux

Custom Viewer

When the default viewer does not meet the needs, you can format your content via customize script.
Method: Pull down the viewer list to the bottom, click "Custom -> Add", and then refer to the instructions below
Note: The script needs to output formatted content through print console.log echo etc., which can be any string or JSON string

Config Description
Name Custom name
Command Executable commands, such as xxx.py xxx.js xxx.class etc. The file needs x permission, which can be executed in the form of ./xxx.py; It can also be set to /bin/node /bin/bash or other system commands, and the script path needs to be placed in Params
Params Parameters spliced after Command, such as "--key {KEY} --value {VALUE}", where {KEY} and {VALUE} will be replaced with the corresponding Redis key and value. Note that if the content is invisible such as binary, you can use {HEX} instead of {VALUE}, and {HEX} will be replaced with the hexadecimal string. If HEX is too long (>8000 chars), it will be written to a temporary file. You can use {HEX_FILE} to obtain the file path, and read by yourself in the script

Configuration example：

Add env to the first line of the script, the final executed command is: ./home/qii/pickle_decoder.py {HEX}, the script can receive parameters via argv[1], ref #978

Command Params
/home/qii/pickle_decoder.py {HEX}
/home/qii/shell_decoder.sh {VALUE}

Without execute permission x：

The final executed command is: /bin/node /home/qii/node_decoder.js {HEX} --key={KEY}, the script can receive parameters via argv[1]

Command Params
/bin/bash /home/qii/shell_decoder.sh {VALUE}
/bin/node /home/qii/node_decoder.js {HEX} --key={KEY}

Start From Command Line(CLI)

If you want to start from command line(CLI), you can pass args to the App.

Examples

# Linux
# ./Another Redis Desktop Manager.AppImage

# Mac
# open /Applications/Another\ Redis\ Desktop\ Manager.app --args

# Windows
"D:\xxxx\Another Redis Desktop Manager.exe"

# COMMON
--host 127.0.0.1 --port 6379 --auth 123
--name tmp_connection

# CLUSTER
--cluster

# SSH
--ssh-host 192.168.0.110
--ssh-username root --ssh-password 123

# SENTINEL
--sentinel-master-name mymaster
--sentinel-node-password 123

# save connection
--save
# readonly mode
--readonly

Parameter Description

Common

Args Description Args Description
--host Redis host* --port Redis port
--auth Password --name Custom name
--separator Key separator --readonly Enable readonly mode
--username Username（Redis6 ACL） --save Enable saving, one-time link by default

SSH

Args Description Args Description
--ssh-host SSH host* --ssh-port SSH port（default:22）
--ssh-username Username* --ssh-password Password
--ssh-private-key Path of private key --ssh-passphrase Password of private key
--ssh-timeout SSH timeout(s)  

CLUSTER

Args Description
--cluster Enable CLUSTER mode

SSL

Args Description Args Description
--ssl Enable SSL* --ssl-key SSL Private Key Pem
--ssl-ca SSL Certificate Authority --ssl-cert SSL Public Key Pem

SENTINEL

Args Description
--sentinel-master-name Name of master group*，like 'mymaster'
--sentinel-node-password Password of Redis node

FAQ

1. How to connect to Redis Cluster in internal network (such as Docker, LAN, AWS)?

Answer: Connect via SSH+Cluster (SSH to the internal network and then connecting to Cluster with internal IP such as 127.0.0.1, 192.168.x.x), you need to fill Redis Host with the internal IP.

How to get Redis internal IP? Connect through SSH, uncheck Cluster option, and then open the console to execute CLUSTER NODES, select any IP in the result.

2. Do I need to fill in the 'Username' in the Redis configuration?

Answer: The access control list (ACL) is only supported in Redis>=6.0, so do not fill it unless you need a special user.

License

MIT

Support

goanother.com   Download Analysis

AnotherRedisDesktopManager (qishibo/AnotherRedisDesktopManager)

Searching Database…

34.8K ·GitHub
AnotherRedisDesktopManager
Что это такое?Another Redis Desktop Manager (AnotherRedisDesktopManager/ARDM) — это графический настольный клиент для управления и просмотра баз данных Redis. Он создан так, чтобы работать быстрее и стабильнее других GUI-инструментов для Redis, особенно с огромным количеством ключей.
Это настольное приложение или CLI-инструмент?Это настольное приложение с графическим интерфейсом на базе Electron, но оно также поддерживает запуск подключений напрямую через аргументы командной строки.
Нужно ли что-то кроме самого приложения, чтобы подключиться к Redis?Для базовых подключений никаких дополнительных инструментов не нужно. Но для подключения к Redis Cluster внутри приватной сети (Docker, LAN, AWS) нужно идти через SSH-туннель, чтобы добраться до внутреннего IP.
Есть ли подводные камни при установке на Mac?На macOS, если приложение не открывается после установки через brew или dmg, нужно вручную удалить атрибут карантина Gatekeeper командой в терминале, а затем снова открыть приложение.
Работает ли это на Linux, Windows и Mac?Да, для всех трёх систем есть нативные пакеты: AppImage/snap для Linux, exe/chocolatey/winget для Windows и dmg/brew cask для Mac.
Какие режимы развёртывания Redis поддерживаются?Поддерживаются одиночный Redis, режим Cluster, Sentinel, подключения через SSH-туннель (включая SSH к Cluster) и зашифрованные подключения SSL/TLS.
Можно ли настроить отображение значений?Да, можно добавить Custom Viewer, который пропускает значение ключа через внешний скрипт или команду (Python, Node, shell и т. д.) и показывает отформатированный результат работы скрипта вместо исходного значения.
Какие типы данных и форматы можно просматривать и декодировать?Помимо обычных строк, хешей, списков, множеств, сортированных множеств и потоков, есть встроенные просмотрщики для JSON, Msgpack, Protobuf, сериализованных данных Java/Pickle и сжатых значений Gzip/Brotli/Deflate, а также новая поддержка типов TimeSeries и Vector/ARRAY.
Можно ли управлять подключениями скриптом, а не кликать по интерфейсу?Да, приложение принимает аргументы командной строки, такие как --host, --port, --auth, --cluster, --ssh-host, а также флаги SSL и Sentinel, так что можно запустить нужное подключение прямо из терминала или скрипта.
What are similar projects?medis, tiny-rdm, dbx, redis-py, beekeeper-studio, tusk, phpredis, RedisDesktopManager
Which topics is it in?redis-client, redis-cluster, database-client, ssh, redis, electron, vue, command-line, database, desktop, productivity, gui
Creator
qishibo
Size
6.5 MB
Stars
34.8K
Updated
CommitAug 20Releasev1.7.4Aug 18
Age
7y
Commits · 90 Days