Technical Documentation: tiny-craft/tiny-rdm

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`) Copy Section

Tiny RDM

**English** | [简体中文](https://github.com/tiny-craft/tiny-rdm/blob/main/README_zh.md) | [繁體中文](https://github.com/tiny-craft/tiny-rdm/blob/main/README_tw.md) | [日本語](https://github.com/tiny-craft/tiny-rdm/blob/main/README_ja.md) | [한국어](https://github.com/tiny-craft/tiny-rdm/blob/main/README_ko.md) | [Français](https://github.com/tiny-craft/tiny-rdm/blob/main/README_fr.md) | [Español](https://github.com/tiny-craft/tiny-rdm/blob/main/README_es.md) | [Português (BR)](https://github.com/tiny-craft/tiny-rdm/blob/main/README_pt.md) | [Русский](https://github.com/tiny-craft/tiny-rdm/blob/main/README_ru.md) | [Türkçe](https://github.com/tiny-craft/tiny-rdm/blob/main/README_tr.md)

Feature Copy Chapter

• Super lightweight, built on Webview2, without embedded browsers (Thanks
  to Wails).
• Provides visually and user-friendly UI, light and dark themes (Thanks
  to Naive UI
  and IconPark).
• Multi-language support (Need more languages ? Click here to contribute).
• Better connection management: supports SSH Tunnel/SSL/Sentinel Mode/Cluster Mode/HTTP proxy/SOCKS5 proxy.
• Visualize key value operations, CRUD support for Lists, Hashes, Strings, Sets, Sorted Sets, and Streams.
• Support multiple data viewing format and decode/decompression methods.
• Use SCAN for segmented loading, making it easy to list millions of keys.
• Logs list for command operation history.
• Provides command-line mode.
• Provides slow logs list.
• Segmented loading and querying for List/Hash/Set/Sorted Set.
• Provide value decode/decompression for List/Hash/Set/Sorted Set.
• Integrate with Monaco Editor
• Support real-time commands monitoring.
• Support import/export data.
• Support publish/subscribe.
• Support import/export connection profile.
• Custom data encoder and decoder for value
  display (Here are the instructions).

Installation Copy Chapter

Available to download for free from here.

If you can't open it after installation on macOS, exec the following command then reopen:

shell Copy

sudo xattr -d com.apple.quarantine /Applications/Tiny\ RDM.app

Build Guidelines Copy Chapter

Prerequisites Copy Section

• Go (latest version)
• Node.js >= 20
• NPM >= 9

Install Wails Copy Section

go install github.com/wailsapp/wails/v2/cmd/wails@latest

Pull the Code Copy Section

git clone https://github.com/tiny-craft/tiny-rdm --depth=1

Build Frontend Copy Section

npm install --prefix ./frontend

or

cd frontend
npm install

Compile and Run Copy Section

wails dev

Docker Deployment Copy Chapter

In addition to the desktop client, Tiny RDM also provides a web version that can be quickly deployed via Docker.

Using Docker Compose (Recommended) Copy Section

Create a docker-compose.yml file:

services:
  tinyrdm:
    image: ghcr.io/tiny-craft/tiny-rdm:latest
    container_name: tinyrdm
    restart: unless-stopped
    ports:
      - "8086:8086"
    environment:
      - ADMIN_USERNAME=admin
      - ADMIN_PASSWORD=tinyrdm
    volumes:
      - ./data:/app/tinyrdm

Start the service:

docker compose up -d

Once started, visit http://localhost:8086 and log in with the credentials configured above.

Using Docker Command Copy Section

docker run -d --name tinyrdm \
  -p 8086:8086 \
  -e ADMIN_USERNAME=admin \
  -e ADMIN_PASSWORD=tinyrdm \
  -v ./data:/app/tinyrdm \
  ghcr.io/tiny-craft/tiny-rdm:latest

Environment Variables Copy Section

Sponsor Copy Chapter

Thanks to the following service providers for hosting sponsorship

About Copy Chapter

Wechat Official Account Copy Section

Overview (`build/README.md`) Copy Section

Build Directory

The build directory is used to house all the build files and assets for your application.

The structure is:

• bin - Output directory
• darwin - macOS specific files
• windows - Windows specific files

Mac Copy Chapter

The darwin directory holds files specific to Mac builds.
These may be customised and used as part of the build. To return these files to the default state, simply delete them
and
build with wails build.

The directory contains the following files:

• Info.plist - the main plist file used for Mac builds. It is used when building using wails build.
• Info.dev.plist - same as the main plist file but used when building using wails dev.

Windows Copy Chapter

The windows directory contains the manifest and rc files used when building with wails build.
These may be customised for your application. To return these files to the default state, simply delete them and
build with wails build.

• icon.ico - The icon used for the application. This is used when building using wails build. If you wish to
  use a different icon, simply replace this file with your own. If it is missing, a new icon.ico file
  will be created using the appicon.png file in the build directory.
• installer/* - The files used to create the Windows installer. These are used when building using wails build.
• info.json - Application details used for Windows builds. The data here will be used by the Windows installer,
  as well as the application itself (right click the exe -> properties -> details)
• wails.exe.manifest - The main application manifest file.

--- METRICS ---

• Files Extracted: 2
• Estimated Token Budget: ~1992 tokens
• Canonical Reference: https://codewiki.google/github.com/tiny-craft/tiny-rdm