Step 1下载安装包

从 GitHub Releases 下载对应平台的安装包，或者直接用包管理器安装：

# macOS (Homebrew)
brew install --cask dbx

# Windows (WinGet / Scoop)
winget install t8y2.dbx
scoop bucket add dbx https://github.com/t8y2/scoop-bucket
scoop install dbx

# Linux (Flatpak)
flatpak remote-add --if-not-exists flatpark https://dl.flatpark.org/flatpark.flatpakrepo
flatpak install flatpark com.dbxio.dbx

Step 2安装并首次启动

1. 双击安装包，按提示完成安装（Windows 便携版解压即用）。
2. 启动 DBX，首次打开会进入连接管理页，界面默认跟随系统语言，可在设置中切换为简体中文。
3. 深色模式会自动同步系统主题，也可以在「设置 → 外观」里手动选择，编辑器另有 9 种主题可选。

Step 3（可选）团队自托管 Web 版

如果想让整个团队共用一个入口，用 Docker 一条命令部署 Web 版：

docker run -d --pull=always --name dbx -p 4224:4224 \
  -v dbx-data:/app/data t8y2/dbx:latest

# 国内拉取加速可用镜像：
# docker.cnb.cool/dbxio.com/dbx:latest

部署完成后浏览器访问 http://localhost:4224 即可使用，功能和桌面版完全一致。

Step 1新建连接

1. 点击左上角「新建连接」，在数据库类型列表中选择对应类型（如 MySQL）。
2. 填写主机地址、端口、用户名和密码，点击「测试连接」。
3. 提示连接成功后保存，左侧即可浏览库、表、视图、索引等对象。

DBX 原生支持 90 多种数据源，国产数据库尤其齐全：

Step 2内网数据库走 SSH 隧道

在连接编辑页勾选「SSH 隧道」，填写跳板机地址和账号，支持密钥和密码两种认证方式。这样公网无法直达的内网库也能安全连接。

Step 3一键迁移旧工具的连接

如果你之前用 DBeaver 或 Navicat，不用一个个重填：在「设置 → 连接导入」里直接选择从 DBeaver / Navicat 导入，已有的连接配置会自动迁移过来。

Step 1在项目根目录的 .mcp.json 中添加配置

{
  "mcpServers": {
    "dbx": { "command": "npx", "args": ["-y", "@dbx-app/mcp-server"] }
  }
}

服务器环境也可以下载 Release 页提供的预编译二进制，无需 Node.js 即可运行。

Step 2设置执行权限

打开「设置 → MCP」，维护连接白名单，并将权限锁定为三档之一：只读（read_only）、数据读写（safe_write）、完全访问（high_risk_write）。建议生产库永远保持只读。