docs: 更新 AGENTS.md 和 README.md
This commit is contained in:
@@ -14,6 +14,9 @@ Fork of [AnotherRedisDesktopManager](https://github.com/qishibo/AnotherRedisDesk
|
||||
- **Module system:** `"type": "module"` (ESM) — main outputs `.js`, preload outputs `.mjs`
|
||||
- **Redis client:** ioredis 5 (main process only)
|
||||
- **Persistence:** electron-store + safeStorage (credentials)
|
||||
- **Virtual scrolling:** @tanstack/vue-virtual (large list rendering)
|
||||
- **Code editor:** @guolao/vue-monaco-editor (Monaco editor integration)
|
||||
- **SSH tunnel:** ssh2 (SSH tunnel support for Redis connections)
|
||||
|
||||
## Commands
|
||||
|
||||
@@ -64,8 +67,8 @@ Renderer (src/renderer/)
|
||||
├── App.vue # Shell layout (TitleBar + Sidebar + MainArea + StatusBar)
|
||||
├── env.d.ts # Vite client + *.vue / *.css module declarations
|
||||
├── stores/
|
||||
│ ├── app.ts # theme, fontSize, scanCount
|
||||
│ ├── connection.ts # connections CRUD, connect/disconnect, health check
|
||||
│ ├── app.ts # theme, fontSize, zoom, fontFamily
|
||||
│ ├── connection.ts # connections CRUD, connect/disconnect, health check, import/export
|
||||
│ └── key.ts # key list, scan, tree view, selected key data
|
||||
├── components/
|
||||
│ ├── layout/ # App shell
|
||||
@@ -90,13 +93,15 @@ Renderer (src/renderer/)
|
||||
│ │ ├── ZsetEditor.vue # sorted set with scores
|
||||
│ │ ├── StreamEditor.vue # stream entries
|
||||
│ │ └── ReJsonEditor.vue # JSON.GET / JSON.SET editing
|
||||
│ ├── common/ # Shared components
|
||||
│ │ └── VirtualScrollList.vue # virtual scrolling for large lists
|
||||
│ └── views/ # Tab content views
|
||||
│ ├── StatusView.vue # INFO dashboard with stat cards
|
||||
│ ├── CliView.vue # interactive terminal
|
||||
│ ├── SlowLogView.vue # slow log table
|
||||
│ ├── MemoryAnalysis.vue # MEMORY USAGE scan & sort
|
||||
│ ├── CommandLog.vue # command execution history
|
||||
│ └── SettingsView.vue # theme, language, font
|
||||
│ └── SettingsView.vue # theme, language, font, zoom
|
||||
├── i18n/
|
||||
│ ├── index.ts # useI18n composable
|
||||
│ └── locales/
|
||||
@@ -106,7 +111,8 @@ Renderer (src/renderer/)
|
||||
│ ├── ko.ts # 한국어
|
||||
│ └── de.ts # Deutsch
|
||||
├── composables/
|
||||
│ └── useKeyboard.ts # keyboard shortcut handler
|
||||
│ ├── useKeyboard.ts # keyboard shortcut handler
|
||||
│ └── useTypeColor.ts # Redis type color mapping
|
||||
├── styles/
|
||||
│ ├── variables.css # CSS custom properties
|
||||
│ └── global.css # global overrides
|
||||
@@ -250,6 +256,27 @@ If output directory or file extensions change, update these paths accordingly.
|
||||
- `safeStorage` - OS-level encryption for credentials
|
||||
- All Redis operations go through typed IPC to main process
|
||||
|
||||
## Connection Features
|
||||
|
||||
### SSH Tunnel
|
||||
- TCP tunnel via ssh2 library
|
||||
- Password or private key authentication
|
||||
- Passphrase support for encrypted keys
|
||||
|
||||
### Sentinel Mode
|
||||
- Redis Sentinel support for high availability
|
||||
- Configure sentinel host, port, and master name
|
||||
- Automatic failover support
|
||||
|
||||
### Cluster Mode
|
||||
- Redis Cluster support
|
||||
- Automatic slot routing
|
||||
- Multi-node connection handling
|
||||
|
||||
### TLS/SSL
|
||||
- CA certificate, client certificate, and private key support
|
||||
- Optional server certificate verification
|
||||
|
||||
## Legacy
|
||||
|
||||
The `legacy/` directory contains the old Vue 2 + Webpack 4 codebase. It is gitignored and not part of the v2 build. See `legacy/AGENTS.md` for its documentation.
|
||||
|
||||
Reference in New Issue
Block a user