kami-redis 2.1.4 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -7
- package/dist/index.d.ts +1 -2364
- package/dist/index.js +14 -1
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
## kami-redis — Inspect Redis keys from your CLI
|
|
2
2
|
|
|
3
|
-
A tiny CLI to browse keys, view nicely formatted values, copy them, or delete — fast and simple.
|
|
3
|
+
A tiny CLI to browse Redis keys safely, view nicely formatted values, copy them, or delete with confirmation — fast and simple.
|
|
4
4
|
|
|
5
5
|
### Demo
|
|
6
6
|
|
|
@@ -9,8 +9,10 @@ A tiny CLI to browse keys, view nicely formatted values, copy them, or delete
|
|
|
9
9
|
### Features
|
|
10
10
|
|
|
11
11
|
- **Pretty output** with JSON detection and syntax highlighting
|
|
12
|
-
- **
|
|
12
|
+
- **Safe key browsing** with incremental `SCAN`, `--pattern` filtering, and a selector limit
|
|
13
|
+
- **Quick actions**: `c` copy with feedback, `d` delete with confirmation, `←` back, `Ctrl+C` quit
|
|
13
14
|
- **Supports** `string`, `hash`, `list`, `set`, `zset`
|
|
15
|
+
- **Clipboard support** for macOS (`pbcopy`), Windows/PowerShell (`Set-Clipboard`/`clip.exe`), WSL (`clip.exe`), Linux Wayland (`wl-copy`), Linux X11 (`xclip`/`xsel`), Termux, and OSC 52 terminal fallback
|
|
14
16
|
|
|
15
17
|
### Install
|
|
16
18
|
|
|
@@ -29,27 +31,48 @@ kami-redis redis://localhost:6379
|
|
|
29
31
|
kami-redis rediss://user:pass@host:6380/0
|
|
30
32
|
```
|
|
31
33
|
|
|
34
|
+
### Seed local test data
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
bun run seed
|
|
38
|
+
# or target another Redis URL
|
|
39
|
+
bun run seed redis://localhost:6379
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
The seed script writes deterministic `kami:test:*` keys covering core Redis types: `string`, `hash`, `list`, `set`, `zset`, and `stream`.
|
|
43
|
+
|
|
32
44
|
### Usage
|
|
33
45
|
|
|
34
46
|
```text
|
|
35
47
|
Usage
|
|
36
|
-
kami-redis <url>
|
|
48
|
+
kami-redis <url> [--pattern <glob>] [--limit <number>]
|
|
49
|
+
|
|
50
|
+
Options
|
|
51
|
+
--pattern, -p Redis key pattern to browse (default: *)
|
|
52
|
+
--limit, -l Maximum keys to load into the selector (default: 500)
|
|
37
53
|
```
|
|
38
54
|
|
|
39
55
|
Examples:
|
|
40
56
|
|
|
57
|
+
```bash
|
|
58
|
+
kami-redis redis://localhost:6379 --pattern "user:*"
|
|
59
|
+
kami-redis redis://localhost:6379 --limit 1000
|
|
60
|
+
```
|
|
61
|
+
|
|
41
62
|
### Shortcuts
|
|
42
63
|
|
|
43
|
-
- `
|
|
44
|
-
- `
|
|
64
|
+
- `Enter` or `→`: Open the selected key
|
|
65
|
+
- `c`: Copy current value and show copy status
|
|
66
|
+
- `d`: Ask for `y` confirmation, then delete current key
|
|
45
67
|
- `←`: Back to keys list
|
|
46
68
|
- `Ctrl+C`: Quit
|
|
47
69
|
|
|
48
70
|
### Supported types
|
|
49
71
|
|
|
50
|
-
- `string`, `hash`, `list`, `set`, `zset`
|
|
72
|
+
- `string`, `hash`, `list`, `set`, `zset`, `stream`
|
|
73
|
+
- Redis Stack module keys for JSON (`ReJSON-RL` / `json`), TimeSeries (`TSDB-TYPE`), and vector sets (`vectorset`) when available
|
|
51
74
|
|
|
52
|
-
|
|
75
|
+
Values stay clean; large collections show a capped preview, and expiring keys show a minimal timer like `15 min`, `30 sec`, or `2 hr`.
|
|
53
76
|
|
|
54
77
|
## Feedback
|
|
55
78
|
|