Registry / database / p3x-redis-ui

p3x-redis-ui

JSON →
library2026.4.2007jsnpmunverified

P3X Redis UI is a feature-rich Redis GUI that runs as a web server application or standalone desktop app (Electron). Current stable version is 2026.4.2007, released weekly with active development. It uniquely offers three interchangeable frontends (Angular, React, Vue) with full feature parity, live switching via Settings. Supports SSH, cluster, sentinel, ACL management, JSON editing with CodeMirror, binary upload/download, and 54 languages. Includes an AI assistant with 15 read-only Redis tools. Can be deployed via Docker, npm, or Snapcraft. Minimum Node.js v22 required.

npm install p3x-redis-ui
INSTALL
IMPORT
SIG · P3X-REDIS-UI
P
p3x-redis-ui
databasejavascriptv2026.4.2007
Install
Import
Disk
Pass rate
0/ 6
Env Coverage0 / 6
glibc
1822
musl
1822
Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
node 18226 runs
build_error
glibc
node 18226 runs
build_error
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

default
import p3xRedisUi from 'p3x-redis-ui'
const p3xRedisUi = require('p3x-redis-ui')
ESM-only since v2025. CommonJS require() will fail.
Server
import { Server } from 'p3x-redis-ui/server'
import Server from 'p3x-redis-ui/server'
Named export, not default. Available in server bundle only.
ElectronApp
import { ElectronApp } from 'p3x-redis-ui/electron'
import { Electron } from 'p3x-redis-ui'
ElectronApp is exported from the electron subpath. Not available in web mode.
RedisConnection
import { RedisConnection } from 'p3x-redis-ui/lib/connection'
import { Connection } from 'p3x-redis-ui'
Full path required for internal modules; not exposed at package root.

Starts the P3X Redis UI web server on port 7843 (or from environment variable), connecting to a local Redis instance with optional password.

// Quick start: run as a web server import p3xRedisUi from 'p3x-redis-ui'; const server = new p3xRedisUi.Server({ port: process.env.PORT ? parseInt(process.env.PORT) : 7843, settingsPath: process.env.SETTINGS_PATH ?? './settings', redis: { host: process.env.REDIS_HOST ?? '127.0.0.1', port: process.env.REDIS_PORT ? parseInt(process.env.REDIS_PORT) : 6379, password: process.env.REDIS_PASSWORD ?? '' } }); server.start().then(() => { console.log('P3X Redis UI started on http://localhost:' + server.port); }).catch(err => { console.error('Failed to start:', err); process.exit(1); });
p3x-redis-ui --version
Debug
Known issues
breakingMinimum Node.js version raised to 22.0.0 (from 12.13.0) since v2026.4. Older Node.js versions will cause runtime errors.
fix
Upgrade Node.js to v22.0.0 or later.
affects: <2026.4
breakingESM-only from v2025. CommonJS require() calls will fail with ERR_REQUIRE_ESM.
fix
Switch to import syntax or use dynamic import().
affects: >=2025.0.0
deprecatedThe legacy AngularJS frontend (deprecated) was removed. All existing installations default to Angular.
fix
Use Settings > GUI to switch to React or Vue if needed.
affects: >=2026.0.0
gotchaThe default server port changed from 7843 to 8080 in v2025.1. Configurations relying on the old default may fail.
fix
Explicitly set PORT environment variable or pass port option.
affects: >=2025.1.0
deprecatedThe SAVE command is replaced by BGSAVE for non-blocking snapshots (since v2026.4.2005). Old configs using SAVE may cause permission errors if Redis denies BGSAVE.
fix
Ensure Redis user has BGSAVE permission or configure server accordingly.
affects: >=2026.4.2005
gotchaDocker: Use latest tag with imagePullPolicy: Always. Version-specific tags are not guaranteed to be stable.
fix
Always pull patrikx3/p3x-redis-ui:latest and set imagePullPolicy: Always.
affects: all
gotchaLive demo at p3x.redis.patrikx3.com resets data daily (CET) and may differ from npm/GitHub release. Do not use for production or sensitive data.
fix
Run your own instance via Docker or npm for persistent data.
affects: all
Errors
Common errors & fixes
Error: Cannot find module 'p3x-redis-ui'
Missing or incorrect import path, or package not installed.
fix
Run 'npm install p3x-redis-ui' and use correct import: 'import p3xRedisUi from 'p3x-redis-ui''
TypeError: Server is not a constructor
Using CommonJS 'require' to import ESM-only package.
fix
Use 'import { Server } from 'p3x-redis-ui/server'' instead of 'const { Server } = require('p3x-redis-ui')'
Error: listen EADDRINUSE :::7843
Port 7843 already in use by another instance.
fix
Kill existing process or set PORT variable to a different port.
Upgrade
Version history
2026.4.2007latest on npm
Audit
Dependencies
ioredisrequiredRedis client for connecting to Redis servers
koarequiredWeb framework for the server-side API
electronoptionalRequired for desktop GUI (optional for web-only usage)
codemirrorrequiredJSON editor component
vuetifyoptionalUI framework for Vue frontend
@angular/materialoptionalUI framework for Angular frontend
@mui/materialoptionalUI framework for React frontend
Agent activity
5 hits · last 30 days
node
4
Amazon
1
Resources