# OpsxDB

**Repository Path**: attacker/opsxdb

## Basic Information

- **Project Name**: OpsxDB
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-09-18
- **Last Updated**: 2026-09-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

> **产品形态**：浏览器 = Gin **官网 + 文档**（`:8788`）；**操作只走桌面 Tauri**。  
> `apps/web`（`:5174`）仅是桌面 `devUrl`/打包源，**不是**浏览器客户端。  
> AI / 协作规范见 [AGENTS.md](./AGENTS.md)（短入口 [CLAUDE.md](./CLAUDE.md)）。

# OpsxDB

给运维和开发用的 **数据库桌面客户端**（连接管理 / SQL 工作台 / AI 写 SQL）。

## 架构

```
packages/ui        连接选择器 + SQL 工作台 + AI 面板（给桌面打包）
packages/core      共享工具
packages/transport Gin / Tauri 传输
apps/web           Vite + React —— **仅桌面前端源**（勿当浏览器产品）
apps/desktop       Tauri 2 壳（唯一操作入口）
apps/server        Gin：官网/docs + health + 驱动 API（:8788）
```

## 怎么跑

```bash
export PATH="$HOME/.nvm/versions/node/v24.19.0/bin:/opt/homebrew/bin:$PATH"
export OPSXDB_SERVER_PORT=8788 OPSXDB_WEB_PORT=5174

npm install
./run.sh web          # 仅官网 + docs → http://127.0.0.1:8788/
./run.sh gui          # 桌面操作入口（推荐）
```

```bash
curl -s http://127.0.0.1:8788/health
open http://127.0.0.1:8788/          # 官网
open http://127.0.0.1:8788/docs      # 文档
```

## 日常怎么用（桌面）

1. `./run.sh gui` → Dock 打开 OpsxDB  
2. **新建连接** → 选类型 / 粘贴 URL → **测试** → **保存并连接**  
3. 左侧对象树点库/表；编辑器 **⌘/Ctrl+Enter** 执行  
4. 结果集：复制 / CSV / 粘贴 / 行删（有主键）

## 已做（摘要）

- 桌面工作台：对象树、SQL、多 Tab、结果编辑、Redis 键浏览（单机）  
- Redis Sentinel/Cluster：表单 + 后端（真拓扑待环境）  
- 自绘右键（编辑器 / 库·表·键）；拦系统菜单  
- Gin 官网 + docs；驱动注册表见 `connection-types/`
- 新引擎接入并本机验收：Elasticsearch（原生 SQL API）、InfluxDB（原生 HTTP+Flux）、ZooKeeper / MongoDB（JVM agent）、达梦（JDBC agent 桥已验证，待实例）
- 驱动管理弹框（连接列表页 ⚙）：agent 驱动状态/预装/离线包导入/JDK 检测；开源驱动首次连接自动下载到 ~/.opsxdb/drivers/

## 端口

| 服务 | 端口 | 说明 |
|------|------|------|
| Gin 官网/docs/API | 8788 | 浏览器只看站点和文档 |
| Vite（桌面源） | 5174 | 仅 `gui`/打包用，非产品入口 |

## 待开发

见 [docs/BACKLOG.md](docs/BACKLOG.md)。