---

🎯 What is WhoDB?

WhoDB 是开发者真正想要使用的现代化数据库管理工具。

基于 GoLang 和 React 构建，WhoDB 是一款轻量级（小于 50MB）但功能强大的数据库客户端，兼具极速性能与直观美观的界面。无论您是在调试生产环境中的问题、探索新的数据库模式，还是为下一个功能管理数据，WhoDB 都能让数据库管理工作变得轻松自如。

为什么选择 WhoDB？

🚀 极速响应 即刻启动（不到 1 秒） 实时查询结果 高效的表格虚拟化技术 资源占用比传统工具低 90% 🎨 美观且直观 干净现代的界面 类似电子表格的数据网格 交互式模式可视化 无需任何培训即可上手

🤖 AI 驱动 自然语言转 SQL 以对话方式与数据互动 支持 Ollama、OpenAI、Anthropic 以及任何兼容 OpenAI 的服务提供商 无需编写复杂查询语句 🔧 开发者友好 多数据库支持 查询历史与管理 模拟数据生成 灵活的导出选项

✨ 核心功能

📊 可视化数据管理

类似电子表格的数据网格 直观地查看、编辑和管理数据 轻松排序、筛选和搜索 内联编辑并实时更新 批量操作提升效率

🔍 交互式模式浏览器

可视化模式拓扑 交互式图表展示 探索表之间的关系 瞬间理解外键 轻松平移、缩放和导航

💻 强大的查询界面

草稿板查询编辑器 类似 Jupyter 的笔记本界面 语法高亮与自动补全 查询历史记录与复用 多单元格组织结构

🗄️ 多数据库支持

社区版 (CE): PostgreSQL、MySQL、SQLite3、MongoDB、Redis、MariaDB、ElasticSearch

企业版 (EE): 包含 CE 版所有数据库，并额外支持 Oracle、SQL Server、DynamoDB、Athena、Snowflake、Cassandra 等更多数据库

🎯 高级功能

• 模拟数据生成 - 为开发生成逼真的测试数据
• 灵活的导出选项 - 支持导出为 CSV、Excel、JSON 或 SQL
• 高级过滤 - 可视化构建复杂的 WHERE 条件
• AI 驱动的查询 - 使用 Ollama、OpenAI、Anthropic 或其他兼容 OpenAI 的服务将自然语言转换为 SQL

---

🎮 立即试用 WhoDB

---

🚀 快速入门

选项 1：Docker（推荐）

开始使用 WhoDB 的最快方式：

docker run -it -p 8080:8080 clidey/whodb

然后在浏览器中打开 http://localhost:8080。

选项 2：Docker Compose

如果您需要更多控制和配置：

version: "3.8"
services:
  whodb:
    image: clidey/whodb
    ports:
      - "8080:8080"
    environment:
      # AI 集成（可选）
      # Ollama 配置
      - WHODB_OLLAMA_HOST=localhost
      - WHODB_OLLAMA_PORT=11434

      # Anthropic 配置
      - WHODB_ANTHROPIC_API_KEY=your_key_here
      # - WHODB_ANTHROPIC_ENDPOINT=https://api.anthropic.com/v1

      # OpenAI 配置
      - WHODB_OPENAI_API_KEY=your_key_here
      # - WHODB_OPENAI_ENDPOINT=https://api.openai.com/v1

      # 通用 AI 提供商（兼容 OpenAI 的接口）
      # 使用 WHODB_AI_GENERIC_<ID>_* 可以添加任何兼容 OpenAI 的提供商。
      # <ID> 可以是任意唯一标识符（如 LMSTUDIO、OPENROUTER）。
      #
      # LM Studio 示例：
      # - WHODB_AI_GENERIC_LMSTUDIO_NAME=LM Studio
      # - WHODB_AI_GENERIC_LMSTUDIO_BASE_URL=http://host.docker.internal:1234/v1
      # - WHODB_AI_GENERIC_LMSTUDIO_MODELS=mistral-7b,llama-3-8b
      #
      # OpenRouter 示例：
      # - WHODB_AI_GENERIC_OPENROUTER_NAME=OpenRouter
      # - WHODB_AI_GENERIC_OPENROUTER_BASE_URL=https://openrouter.ai/api/v1
      # - WHODB_AI_GENERIC_OPENROUTER_API_KEY=your_key_here
      # - WHODB_AI_GENERIC_OPENROUTER_MODELS=google/gemini-2.0-flash-001,anthropic/claude-3.5-sonnet
    # volumes: # （SQLite 可选）
    #   - ./sample.db:/db/sample.db

接下来？

1. 连接到您的数据库 - 在登录页面输入您的数据库凭据
2. 探索您的模式 - 浏览表并可视化关系
3. 运行查询 - 使用草稿板执行 SQL 查询
4. 管理数据 - 轻松编辑、添加和删除记录

📖 有关详细的安装选项和配置，请参阅我们的文档

---

💻 WhoDB CLI

WhoDB 还提供了一个功能强大的命令行界面，带有交互式 TUI（终端用户界面）以及支持 AI 助手的 MCP 服务器。

特性

• 交互式 TUI - 全功能终端界面，用于数据库管理
• MCP 服务器 - 支持 Claude、Cursor 等 AI 工具的模型上下文协议
• 跨平台 - 适用于 macOS、Linux 和 Windows

快速安装

# macOS/Linux
curl -fsSL https://raw.githubusercontent.com/clidey/whodb/main/cli/install/install.sh | bash

# Homebrew（即将推出）
brew install whodb-cli

# npm
npm install -g @clidey/whodb-cli

使用方法

# 启动交互式 TUI
whodb-cli

# 作为 MCP 服务器为 AI 助手服务
whodb-cli mcp serve

📖 有关完整的 CLI 文档，请参阅CLI README

---

🛠️ 开发环境搭建

前提条件

• GoLang - 建议使用最新版本
• PNPM - 用于前端包管理
• Node.js - 版本 16 或更高

版本

社区版（CE） PostgreSQL MySQL / MariaDB SQLite3 MongoDB Redis ElasticSearch

企业版（EE） 包含所有 CE 数据库 Oracle SQL Server DynamoDB Athena Snowflake Cassandra 以及更多...

📚 请参阅 BUILD_AND_RUN.md 获取详细的构建说明，以及 ARCHITECTURE.md 查看架构细节。

前端开发

进入 frontend/ 目录并启动开发服务器：

cd frontend
pnpm i
pnpm start

后端开发

1. 构建前端（首次设置）

如果 core/build/ 目录不存在，请先构建前端：

cd frontend
pnpm install
pnpm run build
rm -rf ../core/build/
cp -r ./build ../core/
cd ..

注意： 这仅需执行一次，因为 Go 会在启动时嵌入 build/ 文件夹。

2. 设置 AI 集成（可选）

要启用自然语言查询：

1. Ollama - 从 ollama.com 下载

   # 安装 Llama 3.1 8b 模型
   ollama pull llama3.1
   

   WhoDB 将自动检测已安装的模型，并在侧边栏中显示一个 聊天 选项。

2. OpenAI/Anthropic - 设置环境变量（参见上面的 Docker Compose 示例）

3. 任何兼容 OpenAI 的提供商 - 使用 WHODB_AI_GENERIC_<ID>_* 环境变量连接到 LM Studio、OpenRouter 或任何具有 OpenAI 兼容 API 的提供商（参见上面的 Docker Compose 示例）

3. 启动后端服务

cd core
go run .

后端将在 http://localhost:8080 上启动

---

💼 使用场景

👨‍💻 对于开发者

本地开发 开发过程中快速检查数据库 以只读方式调试生产问题 使用真实数据测试 API 端点 探索模式变更

API 开发 验证数据转换 测试查询性能 生成模拟数据用于测试 导出数据用于集成测试

📊 对于数据分析师

• 快速运行临时 SQL 查询
• 将数据导出到 Excel 进行分析
• 可视化构建复杂筛选器
• 可视化表之间的关系

🧪 对于 QA 工程师

• 生成逼真的测试数据
• 在测试过程中验证数据库状态
• 快速调试测试失败
• 验证数据迁移

🛠️ 对于数据库管理员

• 监控表结构和索引
• 高效管理用户数据
• 快速探索模式
• 紧急数据修复

---

❓ 常见问题

WhoDB 与其他数据库工具相比有何不同？

WhoDB 结合了 Adminer 等轻量级工具的特点，同时具备现代化的用户体验、强大的可视化功能以及 AI 能力。与 DBeaver 等资源占用较高的工具不同，WhoDB 的内存占用减少了 90%，却提供了更快、更直观的操作体验。

WhoDB 是否适合用于生产环境？

是的，WhoDB 已经准备好用于生产环境，并被数千名开发者使用。对于生产环境，我们建议：

• 尽可能使用只读数据库账号
• 启用 SSL/TLS 连接
• 考虑使用企业版以获得审计日志和高级安全功能

WhoDB 如何处理大型数据集？

WhoDB 实施了多项性能优化措施：

• 表虚拟化以实现高效渲染
• 大型结果集的懒加载
• 分页控件
• 查询结果流式传输

支持哪些数据库？

社区版： PostgreSQL、MySQL、MariaDB、SQLite3、MongoDB、Redis、ElasticSearch

企业版： 包括所有社区版支持的数据库，以及 Oracle、SQL Server、DynamoDB、Athena、Snowflake、Cassandra 等更多数据库

如何部署 WhoDB？

WhoDB 可以通过多种方式部署：

• Docker - 单命令部署
• Docker Compose - 适用于生产环境
• Kubernetes - 适用于企业级环境
• 二进制文件 - 直接安装在服务器上

详情请参阅我们的 快速入门 部分。

WhoDB 会存储我的凭据吗？

不会。默认情况下，WhoDB 不会存储数据库凭据。连接是临时的，关闭浏览器后凭据将被清除。您也可以选择配置本地存储在浏览器中的连接配置文件。

我可以使用 WhoDB 的 AI 功能吗？

可以！WhoDB 集成了以下服务：

• Ollama - 用于本地私有 AI 模型
• OpenAI - GPT-4 及其他 OpenAI 模型
• Anthropic - Claude 模型
• 任何兼容 OpenAI 的提供商 - LM Studio、OpenRouter、vLLM 等，可通过 WHODB_AI_GENERIC_<ID>_* 环境变量进行配置

这些集成使您可以使用自然语言而非 SQL 来查询数据库。

🤝 贡献

我们欢迎社区的贡献！无论是 bug 报告、功能请求，还是代码贡献，我们都感谢您为改进 WhoDB 所做的努力。

如何贡献

1. 报告问题 - 发现了 bug？提交 issue
2. 请求功能 - 有想法吗？发起讨论
3. 提交 PR - 想贡献代码吗？请查看我们的 贡献指南
4. 改进文档 - 帮助我们完善文档

开发资源

• 贡献指南 - 详细的贡献指导
• 架构 - 了解代码库结构
• 构建与运行 - 开发环境设置说明

---

📸 截图

查看更多截图

数据管理

添加/编辑记录

高级筛选

导出选项

模式图可视化

草稿区查询编辑器

查询结果

多数据库支持

---

🏢 基础设施与支持

WhoDB 的部署和 CI/CD 由 Clidey 提供支持，这是一个无代码的 DevOps 平台。

联系与支持

• 邮箱： support@clidey.com
• GitHub Issues： 报告 bug
• 讨论区： 加入讨论
• 文档： docs.whodb.com

---

WhoDB 快速上手指南

WhoDB 是一款轻量、极速且界面美观的现代化数据库管理工具。它基于 GoLang 和 React 构建，支持多种数据库，并提供类似电子表格的数据视图、交互式架构探索以及强大的 AI 自然语言转 SQL 功能。

环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统：Windows, macOS, Linux
• 运行方式：
  • 推荐：Docker（无需安装额外依赖）
  • 本地开发：需安装 GoLang (最新版), Node.js (v16+), PNPM
• 网络要求：访问 Docker Hub 或 GitHub 下载资源（国内用户建议配置 Docker 镜像加速）

安装步骤

方案一：使用 Docker（推荐）

这是最快速的启动方式，适用于所有平台。

1. 拉取并运行镜像 在终端执行以下命令：

   docker run -it -p 8080:8080 clidey/whodb
   

   提示：如果拉取速度较慢，请配置国内 Docker 镜像加速器（如阿里云、腾讯云等）。

2. 访问界面 打开浏览器访问：http://localhost:8080

方案二：使用 Docker Compose（含 AI 配置）

如果您需要配置 AI 功能（如 Ollama、OpenAI）或持久化存储，请使用 docker-compose.yml：

version: "3.8"
services:
  whodb:
    image: clidey/whodb
    ports:
      - "8080:8080"
    environment:
      # AI 集成配置 (可选)
      
      # Ollama 配置 (需确保宿主机运行了 Ollama)
      - WHODB_OLLAMA_HOST=host.docker.internal
      - WHODB_OLLAMA_PORT=11434

      # OpenAI 配置
      - WHODB_OPENAI_API_KEY=your_key_here
      
      # Anthropic 配置
      - WHODB_ANTHROPIC_API_KEY=your_key_here

      # 通用 AI 提供商 (兼容 OpenAI 接口，如 LM Studio, OpenRouter)
      # 示例：LM Studio
      # - WHODB_AI_GENERIC_LMSTUDIO_NAME=LM Studio
      # - WHODB_AI_GENERIC_LMSTUDIO_BASE_URL=http://host.docker.internal:1234/v1
      # - WHODB_AI_GENERIC_LMSTUDIO_MODELS=mistral-7b,llama-3-8b

启动服务：

docker compose up -d

方案三：命令行工具 (CLI)

WhoDB 还提供带有交互式 TUI 和 MCP 服务器支持的命令行版本。

安装命令：

• macOS / Linux:

  curl -fsSL https://raw.githubusercontent.com/clidey/whodb/main/cli/install/install.sh | bash
  

• npm (跨平台):

  npm install -g @clidey/whodb-cli
  

基本使用

1. 连接数据库

启动 WhoDB 后，在登录页面输入您的数据库连接信息：

• 支持数据库 (社区版)：PostgreSQL, MySQL, SQLite3, MongoDB, Redis, MariaDB, ElasticSearch。
• 输入 Host, Username, Password 和 Database 名称，点击登录。

2. 可视化数据管理

• 数据网格：登录后，您可以像操作 Excel 一样查看和编辑数据。支持排序、过滤、搜索和内联编辑。
• 架构拓扑：点击左侧菜单的 Schema 视图，通过交互式图表查看表之间的关系和外键约束。

3. 执行查询 (Scratchpad)

• 进入 Scratchpad 界面，这是一个类似 Jupyter Notebook 的查询编辑器。
• 编写 SQL 语句，支持语法高亮和自动补全。
• 可以将复杂的查询拆分为多个单元格执行，并保存查询历史。

4. 使用 AI 辅助查询 (可选)

如果您已配置 AI 环境变量或本地运行了 Ollama：

• 在查询界面选择 Chat 模式。
• 直接使用自然语言提问（例如：“找出销售额最高的前 10 名用户”）。
• WhoDB 会自动将其转换为 SQL 并执行，无需手动编写复杂语句。

5. CLI 快速使用

如果您安装的是 CLI 版本：

• 启动交互界面：

  whodb-cli
  

• 作为 AI 助手 MCP 服务器运行：

  whodb-cli mcp serve
  

  (此模式可让 Cursor、Claude 等 AI 编程助手直接连接并操作您的数据库)