From 9c0bcae04d8ecdc73594748ac5783de5b78abc20 Mon Sep 17 00:00:00 2001 From: "Mr.Online" Date: Thu, 7 Sep 2023 10:38:36 +0530 Subject: [PATCH] feat(redis-commander): add redis commander and cleanup based on guidelines --- redis-commander/README.md | 48 ++++++++++++++++++++++++++++++++++++++ redis-commander/install.sh | 13 +++++++++++ 2 files changed, 61 insertions(+) create mode 100644 redis-commander/README.md create mode 100644 redis-commander/install.sh diff --git a/redis-commander/README.md b/redis-commander/README.md new file mode 100644 index 000000000..9706ecb94 --- /dev/null +++ b/redis-commander/README.md @@ -0,0 +1,48 @@ +--- +title: Redis Commander +homepage: https://joeferner.github.io/redis-commander/ +tagline: | + Redis-Commander is a node.js web application used to view, edit, and manage a Redis Database. +--- + +To update or switch versions, run `npm install -g redis-commander@latest`. + +### Files + +These are the files / directories that are created and/or modified with this +install: + +```text +~/.config/envman/PATH.env +~/.local/opt/node/bin/redis-commander +``` + +If [`node`](/node) is not found, it will also be installed. + +## Cheat Sheet + +> Web-UI to display and edit data within multiple different Redis servers. It +> has support for the following data types to view, add, update and delete data: + +- Strings +- Lists +- Sets +- Sorted Set +- Streams (Basic support based on HFXBus project from + https://github.com/exocet-engineering/hfx-bus, only view/add/delete data) +- ReJSON documents (Basic support, only for viewing values of ReJSON type keys) + +List available commands: + +```sh +redis-commander --help +``` + +Start redis commander with default settings: + +```sh +redis-commander +``` + +This will open up web app at `http://127.0.0.1:8081` and will be connected to +local redis server at default port! diff --git a/redis-commander/install.sh b/redis-commander/install.sh new file mode 100644 index 000000000..2b3319565 --- /dev/null +++ b/redis-commander/install.sh @@ -0,0 +1,13 @@ +#!/bin/sh +set -e +set -u + +__init_redis_commander() { + if [ -z "$(npm --version 2> /dev/null)" ]; then + "$HOME/.local/bin/webi" node + export PATH="$HOME/.local/opt/node/bin:$PATH" + fi + npm install -g redis-commander@latest +} + +__init_redis_commander