Skip to content

xuerzong/redis-dash

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

128 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

English | ็ฎ€ไฝ“ไธญๆ–‡

๐Ÿš€ Redis Dash is a cross-platform Redis GUI (Graphical User Interface) Client. Redis Dash is designed to provide a simple and efficient way to manage and monitor your Redis instances.

โœจ Features

  • ๐Ÿ”— Multi-Connection Support: Easily manage and switch between multiple Redis instances.
  • ๐Ÿ”Ž Intuitive Key Browser: Browse, search, edit, and delete various data types (String, List, Hash, Set, ZSet).
  • ๐ŸŽจ Shiki Theme Selection: Choose from the supported Shiki theme list to customize the interface. See https://shiki.style/themes.
  • ๐Ÿ’ป Built-in CLI Console: A powerful Redis Command Line Interface (CLI) allows you to execute native Redis commands directly.
  • ๐ŸŒ Cross-Platform: Supports Windows, macOS, and Linux.

๐Ÿš€ Get Started

Install

Important

npm installation is no longer supported. Please use the latest install script.

Install Redis Dash with the standalone installer:

curl -fsSL https://download.xuco.me/redis-dash/install.sh | sh

Install a specific version:

curl -fsSL https://download.xuco.me/redis-dash/install.sh | RDS_VERSION=0.2.0 sh

The install script downloads the current platform bundle, installs it under /usr/local/lib/redis-dash or ~/.local/share/redis-dash, and links rds into /usr/local/bin or ~/.local/bin.

The installer uses https://download.xuco.me/redis-dash as the default distribution source.

Start Server

Note

Redis Dash runs as a standalone application, and its server provides the web interface. You still require a running Redis instance to connect to and manage your data.

After installation, use the rds command to manage the background service for Redis Dash.

  • Check Version
rds --version # OR `rds -V`
  • Start Service
rds start
  • Stop Service
rds stop
  • Restart Service
rds restart

๐Ÿ”จ Configuration

Default Settgins

By default, the Redis Dash service runs on port 5090 on localhost.

Custom Port

You can specify a different port using a command-line flag when starting the service:

rds start --port 9000

๐Ÿ’ป How To Dev

cd ./redis-dash

npm install

npm run start

๐Ÿ“ฆ Release

Build the web assets, compile the Rust server binary, and prepare standalone binary artifacts:

npm run release

After the command finishes:

  • The platform native binary is in dist/native/<platform>/rds
  • The standalone binary bundle is in dist/binary/<platform>
  • The standalone install archive is in dist/binary/rds-<platform>.tar.gz

GitHub Actions release flow:

  • Push a v* tag to build binaries and create or update the draft GitHub Release.
  • Review the draft release manually.
  • When the release is ready for users, run the Publish Updater Manifest workflow with that version so latest.json is attached to the release.
  • Then run the Upload Release to R2 workflow to mirror the release assets and latest.json to https://download.xuco.me/redis-dash.