@redis-dev-panel/cli 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,96 @@
+# @redis-dev-panel/cli
+
+> Zero-install CLI for Redis Dev Panel. Run with `npx` — no global install needed.
+
+[![npm version](https://img.shields.io/npm/v/@redis-dev-panel/cli?color=D93B30)](https://npmjs.com/package/@redis-dev-panel/cli)
+[![npm downloads](https://img.shields.io/npm/dm/@redis-dev-panel/cli)](https://npmjs.com/package/@redis-dev-panel/cli)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/your-org/redis-dev-panel/blob/main/LICENSE)
+[![Node.js](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen)](https://nodejs.org)
+
+Launch a full visual Redis debugger from your terminal in one command. No installation, no config files, no Docker.
+
+---
+
+## Usage
+```bash
+npx @redis-dev-panel/cli start
+```
+
+Opens the panel at `http://127.0.0.1:5174`.
+
+---
+
+## Commands
+
+### `start` — Launch the panel
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `--url <url>` | `redis://localhost:6379` | Redis connection URL |
+| `--port <port>` | `5174` | Port to run the panel on |
+| `--host <host>` | `127.0.0.1` | Host to bind to |
+| `--token <token>` | — | Bearer token to protect the panel |
+| `--open` | `false` | Auto-open browser on start |
+```bash
+npx @redis-dev-panel/cli start
+npx @redis-dev-panel/cli start --url redis://:password@localhost:6379
+npx @redis-dev-panel/cli start --url rediss://myhost:6380
+npx @redis-dev-panel/cli start --port 8080 --open
+npx @redis-dev-panel/cli start --token supersecret
+```
+
+### `check` — Test Redis connectivity
+
+Tests the connection and exits. Exit codes: `0` = reachable, `1` = failed.
+```bash
+npx @redis-dev-panel/cli check
+npx @redis-dev-panel/cli check --url redis://staging.internal:6379
+npx @redis-dev-panel/cli check && npm run dev
+```
+
+---
+
+## Environment variables
+```bash
+REDIS_URL=redis://localhost:6379
+PORT=5174
+HOST=127.0.0.1
+AUTH_TOKEN=your-secret
+NODE_ENV=development
+```
+
+---
+
+## What you get
+
+| Feature | Description |
+|---------|-------------|
+| 🔍 Key Explorer | Browse all key types — string, hash, list, set, zset, stream |
+| 📡 Live Monitor | Stream every Redis command in real-time |
+| 🔔 Pub/Sub Inspector | Subscribe to channels, publish test messages |
+| ⏱ Expiring Keys | See keys about to expire with a TTL heatmap |
+| 📊 Metrics | Live memory, ops/sec, hit rate charts |
+| 🔗 Multi-Connection | Switch between Redis instances at runtime |
+
+---
+
+## Security
+
+- Binds to `127.0.0.1` — not reachable from the network
+- Blocked when `NODE_ENV=production`
+- Use `--token` on shared machines
+
+---
+
+## Related
+
+- [`@redis-dev-panel/server`](https://npmjs.com/package/@redis-dev-panel/server) — embed the panel in your Node.js app
+- [`@redis-dev-panel/core`](https://npmjs.com/package/@redis-dev-panel/core) — Redis abstraction engine
+
+[GitHub](https://github.com/your-org/redis-dev-panel) · [Issues](https://github.com/your-org/redis-dev-panel/issues)
+
+---
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redis-dev-panel/cli",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "CLI for Redis Dev Panel — npx redis-dev-panel",
   "main": "src/index.js",
   "bin": {
@@ -24,7 +24,7 @@
   "dependencies": {
     "commander": "^12.1.0",
     "ioredis": "^5.9.3",
-    "@redis-dev-panel/server": "1.0.0"
+    "@redis-dev-panel/server": "1.0.3"
   },
   "engines": {
     "node": ">=18.0.0"

package/src/index.js

@@ -3,7 +3,16 @@
 
 import { program } from 'commander';
 import { startRedisPanel } from '@redis-dev-panel/server';
-import pkg from '../package.json';
+import { readFileSync } from 'fs';
+import { fileURLToPath } from 'url';
+import path from 'path';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const pkg = JSON.parse(
+    readFileSync(path.join(__dirname, '../package.json'), 'utf-8')
+);
 
 program
     .name('redis-dev-panel')