Skip to content
Back to search

dbx

25 MB lightweight cross-platform database client for 100+ databases, including MySQL, PostgreSQL, SQLite, Redis, MongoDB, DuckDB, SQL Server, and Dameng. Built-in AI, MCP Server, CLI, desktop and Docker. | 轻量级跨平台数据库管理工具,支持 MySQL、PostgreSQL、SQLite、Redis、MongoDB、达梦等 100+ 数据库,提供桌面端、Docker、CLI、内置 AI 助手和 MCP。

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/t8y2/dbx with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/t8y2/dbx'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/t8y2--dbx/badge.svg)](/listings/t8y2--dbx)

HTML

<a href="/listings/t8y2--dbx"><img src="/api/listings/t8y2--dbx/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Download the latest release from the [Releases](https://github.com/t8y2/dbx/releases/latest) page.

**Homebrew (macOS):**

brew install --cask dbx

**Scoop (Windows):**

scoop bucket add dbx https://github.com/t8y2/scoop-bucket
scoop install dbx

**WinGet (Windows):**

winget install t8y2.dbx

**Flatpak (Linux):**

flatpak remote-add --if-not-exists flatpark https://dl.flatpark.org/flatpark.flatpakrepo
flatpak install flatpark com.dbxio.dbx

Updates then arrive through the regular `flatpak update`. See the [DBX page on FlatPark](https://flatpark.org/apps/com.dbxio.dbx/) for details.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 669 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. <div align="center">
  2. <p style="font-size: 18px; white-space: nowrap;"><strong>100+ databases in 25 MB. Desktop, Docker, CLI, built-in AI assistant, and MCP Server.</strong></p>
  3. <p>
  4. <img src="https://dl.dbxio.com/assets/readme-hero-20260925.png" alt="DBX screenshot" width="820" />
  5. </p>
  6. <p>
  7. <a href="https://github.com/t8y2/dbx/releases"><img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fshieldcn.dev%2Fgithub%2Fdownloads%2Ft8y2%2Fdbx%2Fshields.json&amp;style=for-the-badge" /></a>
  8. <a href="https://qm.qq.com/cgi-bin/qm/qr?k=&group_code=244975070"><img src="https://img.shields.io/badge/QQ_群-244975070-EB1923?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iODYiIHdpZHRoPSI4NiIgdmlld0JveD0iMCAwIDEyMCAxNDUiPjxwYXRoIGZpbGw9IiNmYWFiMDciIGQ9Ik02MC41MDMgMTQyLjIzN2MtMTIuNTMzIDAtMjQuMDM4LTQuMTk1LTMxLjQ0NS0xMC40Ni0zLjc2MiAxLjEyNC04LjU3NCAyLjkzMi0xMS42MSA1LjE3NS0yLjYgMS45MTgtMi4yNzUgMy44NzQtMS44MDcgNC42NjMgMi4wNTYgMy40NyAzNS4yNzMgMi4yMTYgNDQuODYyIDEuMTM2em0wIDBjMTIuNTM1IDAgMjQuMDM5LTQuMTk1IDMxLjQ0Ny0xMC40NiAzLjc2IDEuMTI0IDguNTczIDIuOTMyIDExLjYxIDUuMTc1IDIuNTk4IDEuOTE4IDIuMjc0IDMuODc0IDEuODA1IDQuNjYzLTIuMDU2IDMuNDctMzUuMjcyIDIuMjE2LTQ0Ljg2MiAxLjEzNnptMCAwIi8+PHBhdGggZD0iTTYwLjU3NiA2Ny4xMTljMjAuNjk4LS4xNCAzNy4yODYtNC4xNDcgNDIuOTA3LTUuNjgzIDEuMzQtLjM2NyAyLjA1Ni0xLjAyNCAyLjA1Ni0xLjAyNC4wMDUtLjE4OS4wODUtMy4zNy4wODUtNS4wMUMxMDUuNjI0IDI3Ljc2OCA5Mi41OC4wMDEgNjAuNSAwIDI4LjQyLjAwMSAxNS4zNzUgMjcuNzY5IDE1LjM3NSA1NS40MDFjMCAxLjY0Mi4wOCA0LjgyMi4wODYgNS4wMSAwIDAgLjU4My42MTUgMS42NS45MTMgNS4xOSAxLjQ0NCAyMi4wOSA1LjY1IDQzLjMxMiA1Ljc5NXptNTYuMjQ1IDIzLjAyYy0xLjI4My00LjEyOS0zLjAzNC04Ljk0NC00LjgwOC0xMy41NjggMCAwLTEuMDItLjEyNi0xLjUzNy4wMjMtMTUuOTEzIDQuNjIzLTM1LjIwMiA3LjU3LTQ5LjkgNy4zOTJoLS4xNTNjLTE0LjYxNi4xNzUtMzMuNzc0LTIuNzM3LTQ5LjYzNC03LjMxNS0uNjA2LS4xNzUtMS44MDItLjEtMS44MDItLjEtMS43NzQgNC42MjQtMy41MjUgOS40NC00LjgwOCAxMy41NjgtNi4xMTkgMTkuNjktNC4xMzYgMjcuODM4LTIuNjI3IDI4LjAyIDMuMjM5LjM5MiAxMi42MDYtMTQuODIxIDEyLjYwNi0xNC44MjEgMCAxNS40NTkgMTMuOTU3IDM5LjE5NSA0NS45MTggMzkuNDEzaC44NDhjMzEuOTYtLjIxOCA0NS45MTctMjMuOTU0IDQ1LjkxNy0zOS40MTMgMCAwIDkuMzY4IDE1LjIxMyAxMi42MDcgMTQuODIyIDEuNTA4LS4xODMgMy40OTEtOC4zMzItMi42MjctMjguMDIxIi8+PHBhdGggZmlsbD0iI2ZmZiIgZD0iTTQ5LjA4NSA0MC44MjRjLTQuMzUyLjE5Ny04LjA3LTQuNzYtOC4zMDQtMTEuMDYzLS4yMzYtNi4zMDUgMy4wOTgtMTEuNTc2IDcuNDUtMTEuNzczIDQuMzQ3LS4xOTUgOC4wNjQgNC43NiA4LjMgMTEuMDY1LjIzOCA2LjMwNi0zLjA5NyAxMS41NzctNy40NDYgMTEuNzcxbTMxLjEzMy0xMS4wNjNjLS4yMzMgNi4zMDItMy45NTEgMTEuMjYtOC4zMDMgMTEuMDYzLTQuMzUtLjE5NS03LjY4NC01LjQ2NS03LjQ0Ni0xMS43Ny4yMzYtNi4zMDUgMy45NTItMTEuMjYgOC4zLTExLjA2NiA0LjM1Mi4xOTcgNy42ODYgNS40NjggNy40NDkgMTEuNzczIi8+PHBhdGggZmlsbD0iI2ZhYWIwNyIgZD0iTTg3Ljk1MiA0OS43MjVDODYuNzkgNDcuMTUgNzUuMDc3IDQ0LjI4IDYwLjU3OCA0NC4yOGgtLjE1NmMtMTQuNSAwLTI2LjIxMiAyLjg3LTI3LjM3NSA1LjQ0NmEuODYzLjg2MyAwIDAwLS4wODUuMzY3Ljg4Ljg4IDAgMDAuMTYuNDk2Yy45OCAxLjQyNyAxMy45ODUgOC40ODcgMjcuMyA4LjQ4N2guMTU2YzEzLjMxNCAwIDI2LjMxOS03LjA1OCAyNy4yOTktOC40ODdhLjg3My44NzMgMCAwMC4xNi0uNDk4Ljg1Ni44NTYgMCAwMC0uMDg1LS4zNjUiLz48cGF0aCBkPSJNNTQuNDM0IDI5Ljg1NGMuMTk5IDIuNDktMS4xNjcgNC43MDItMy4wNDYgNC45NDMtMS44ODMuMjQyLTMuNTY4LTEuNTgtMy43NjgtNC4wNy0uMTk3LTIuNDkyIDEuMTY3LTQuNzA0IDMuMDQzLTQuOTQ0IDEuODg2LS4yNDQgMy41NzQgMS41OCAzLjc3MSA0LjA3bTExLjk1Ni44MzNjLjM4NS0uNjg5IDMuMDA0LTQuMzEyIDguNDI3LTIuOTkzIDEuNDI1LjM0NyAyLjA4NC44NTcgMi4yMjMgMS4wNTcuMjA1LjI5Ni4yNjIuNzE4LjA1MyAxLjI4Ni0uNDEyIDEuMTI2LTEuMjYzIDEuMDk1LTEuNzM0Ljg3NS0uMzA1LS4xNDItNC4wODItMi42Ni03LjU2MiAxLjA5Ny0uMjQuMjU3LS42NjguMzQ2LTEuMDczLjA0LS40MDctLjMwOC0uNTc0LS45My0uMzM0LTEuMzYyIi8+PHBhdGggZmlsbD0iI2ZmZiIgZD0iTTYwLjU3NiA4My4wOGgtLjE1M2MtOS45OTYuMTItMjIuMTE2LTEuMjA0LTMzLjg1NC0zLjUxOC0xLjAwNCA1LjgxOC0xLjYxIDEzLjEzMi0xLjA5IDIxLjg1MyAxLjMxNiAyMi4wNDMgMTQuNDA3IDM1LjkgMzQuNjE0IDM2LjFoLjgyYzIwLjIwOC0uMiAzMy4yOTgtMTQuMDU3IDM0LjYxNi0zNi4xLjUyLTguNzIzLS4wODctMTYuMDM1LTEuMDkyLTIxLjg1NC0xMS43MzkgMi4zMTUtMjMuODYyIDMuNjQtMzMuODYgMy41MTgiLz48cGF0aCBmaWxsPSIjZWIxOTIzIiBkPSJNMzIuMTAyIDgxLjIzNXYyMS42OTNzOS45MzcgMi4wMDQgMTkuODkzLjYxNlY4My41MzVjLTYuMzA3LS4zNTctMTMuMTA5LTEuMTUyLTE5Ljg5My0yLjMiLz48cGF0aCBmaWxsPSIjZWIxOTIzIiBkPSJNMTA1LjUzOSA2MC40MTJzLTE5LjMzIDYuMTAyLTQ0Ljk2MyA2LjI3NWgtLjE1M2MtMjUuNTkxLS4xNzItNDQuODk2LTYuMjU1LTQ0Ljk2Mi02LjI3NUw4Ljk4NyA3Ni41N2MxNi4xOTMgNC44ODIgMzYuMjYxIDguMDI4IDUxLjQzNiA3Ljg0NWguMTUzYzE1LjE3NS4xODMgMzUuMjQyLTIuOTYzIDUxLjQzNy03Ljg0NXptMCAwIi8+PC9zdmc+" alt="Join QQ Group" /></a>
  9. <a href="https://docs.qq.com/doc/DVVhMY0h1ekJqc0tz" target="_blank"><img src="https://img.shields.io/badge/微信群-Join-07C160?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI%2BPHBhdGggZmlsbD0iIzA3YzE2MCIgZD0iTTguNjkxIDIuMTg4QzMuODkxIDIuMTg4IDAgNS40NzYgMCA5LjUzYzAgMi4yMTIgMS4xNyA0LjIwMyAzLjAwMiA1LjU1YS41OS41OSAwIDAgMSAuMjEzLjY2NWwtLjM5IDEuNDhjLS4wMTkuMDctLjA0OC4xNDEtLjA0OC4yMTNjMCAuMTYzLjEzLjI5NS4yOS4yOTVhLjMzLjMzIDAgMCAwIC4xNjctLjA1NGwxLjkwMy0xLjExNGEuODYuODYgMCAwIDEgLjcxNy0uMDk4YTEwLjIgMTAuMiAwIDAgMCAyLjgzNy40MDNjLjI3NiAwIC41NDMtLjAyNy44MTEtLjA1Yy0uODU3LTIuNTc4LjE1Ny00Ljk3MiAxLjkzMi02LjQ0NmMxLjcwMy0xLjQxNSAzLjg4Mi0xLjk4IDUuODUzLTEuODM4Yy0uNTc2LTMuNTgzLTQuMTk2LTYuMzQ4LTguNTk2LTYuMzQ4TTUuNzg1IDUuOTkxYy42NDIgMCAxLjE2Mi41MjkgMS4xNjIgMS4xOGExLjE3IDEuMTcgMCAwIDEtMS4xNjIgMS4xNzhBMS4xNyAxLjE3IDAgMCAxIDQuNjIzIDcuMTdjMC0uNjUxLjUyLTEuMTggMS4xNjItMS4xOHptNS44MTMgMGMuNjQyIDAgMS4xNjIuNTI5IDEuMTYyIDEuMThhMS4xNyAxLjE3IDAgMCAxLTEuMTYyIDEuMTc4YTEuMTcgMS4xNyAwIDAgMS0xLjE2Mi0xLjE3OGMwLS42NTEuNTItMS4xOCAxLjE2Mi0xLjE4bTUuMzQgMi44NjdjLTEuNzk3LS4wNTItMy43NDYuNTEyLTUuMjggMS43ODZjLTEuNzIgMS40MjgtMi42ODcgMy43Mi0xLjc4IDYuMjJjLjk0MiAyLjQ1MyAzLjY2NiA0LjIyOSA2Ljg4NCA0LjIyOWMuODI2IDAgMS42MjItLjEyIDIuMzYxLS4zMzZhLjcyLjcyIDAgMCAxIC41OTguMDgybDEuNTg0LjkyNmEuMy4zIDAgMCAwIC4xNC4wNDdjLjEzNCAwIC4yNC0uMTExLjI0LS4yNDdjMC0uMDYtLjAyMy0uMTItLjAzOC0uMTc3bC0uMzI3LTEuMjMzYS42LjYgMCAwIDEtLjAyMy0uMTU2YS40OS40OSAwIDAgMSAuMjAxLS4zOThDMjMuMDI0IDE4LjQ4IDI0IDE2LjgyIDI0IDE0Ljk4YzAtMy4yMS0yLjkzMS01LjgzNy02LjY1Ni02LjA4OFY4Ljg5Yy0uMTM1LS4wMS0uMjctLjAyNy0uNDA3LS4wM3ptLTIuNTMgMy4yNzRjLjUzNSAwIC45NjkuNDQuOTY5Ljk4MmEuOTc2Ljk3NiAwIDAgMS0uOTY5Ljk4M2EuOTc2Ljk3NiAwIDAgMS0uOTY5LS45ODNjMC0uNTQyLjQzNC0uOTgyLjk3LS45ODJ6bTQuODQ0IDBjLjUzNSAwIC45NjkuNDQuOTY5Ljk4MmEuOTc2Ljk3NiAwIDAgMS0uOTY5Ljk4M2EuOTc2Ljk3NiAwIDAgMS0uOTY5LS45ODNjMC0uNTQyLjQzNC0uOTgyLjk2OS0uOTgyIi8%2BPC9zdmc%2B" alt="Join WeChat Group" /></a>
  10. <a href="https://applink.feishu.cn/client/chat/chatter/add_by_link?link_token=30cvb14f-a9b1-4b12-adb6-2ff6d476a227" target="_blank"><img src="https://img.shields.io/badge/飞书群-Join-3370FF?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjE2NCAyMDQgNzYyIDYxNyI%2BPHBhdGggZmlsbD0iIzAwRDZCOSIgZD0iTTU1OS45MTUgNTMwLjQ1M2MtNDYuNTA3LTExMS43ODYtMTk0LjU2LTI0OC40NjktMjYyLjgwNi0zMDIuODI2aDMzMy43ODJjNDcuMTQ2IDE2LjI5OCA4Ny42MTYgMTM0LjY3NyAxMDEuOTczIDE5MS44MDgtMzUuNDk5IDMxLjIxLTExOS43ODcgOTcuMTA5LTE3Mi45NSAxMTEuMDE4eiIvPjxwYXRoIGZpbGw9IiMxMzNDOUEiIGQ9Ik02MzIuMDIxIDQ1Mi45OTJjLTQ1LjE4NCA2MC40OC0xMzMuNTQ2IDEyMS45NjMtMTcyLjA1MyAxNDUuMTNsLTIuODggMjQuMjc4IDIzNS45NDcgNjMuNjM3YzMyLjIxMy0yNS45NjIgMTAzLjA2MS04Ny4yOTYgMTI4Ljk2LTEyNC45MjggNC4zOTQtNi4zNzggNjguOTkyLTEzNS45MTQgNzkuNDAyLTE1MS41NTItMTguMjQtMTEuMzA2LTQyLjU2LTE4LjI2MS0xMDQuMjc3LTIxLjczOC04Mi41Ni00LjMzMS0xMTYuNDM3IDIwLjg2NC0xNjUuMDk5IDY1LjE3M3oiLz48cGF0aCBmaWxsPSIjMzM3MEZGIiBkPSJNMTg3Ljg4MyA3MTIuOTE3VjM5My41MTVDMzk3LjU2OCA1OTkuODA4IDU1OC4zMTUgNjQyLjY4OCA2NDEuMDQ1IDY1My43NmMxMjQuNDU5IDUuNDE5IDE1NC42NjctNzMuMDQ1IDE4MS4xNDItOTMuMDk5LTk3LjAyNCAxNTMuMTc0LTIyNC42NCAyMzUuNzM0LTM4NC43NDcgMjM1LjczNC0xMjguMTA3IDAtMjE5Ljc1NS01NS42NTktMjQ5LjU1Ny04My40Nzh6Ii8%2BPC9zdmc%2B" alt="Join Feishu Group" /></a>
  11. <a href="https://discord.gg/W7NyVDRt6a"><img src="https://dcbadge.limes.pink/api/server/W7NyVDRt6a" alt="Join Discord" /></a>
  12. </p>
  13. <p>
  14. <a href="https://trendshift.io/repositories/26775?utm_source=repository-badge&amp;utm_medium=badge&amp;utm_campaign=badge-repository-26775" target="_blank" rel="noopener noreferrer"><img src="https://trendshift.io/api/badge/repositories/26775" alt="t8y2%2Fdbx | Trendshift" width="250" height="55"/></a>
  15. <a href="https://hellogithub.com/repository/t8y2/dbx" target="_blank"><img src="https://api.hellogithub.com/v1/widgets/recommend.svg?rid=7f74ffda697241bf996e17e1b0900a21&claim_uid=p0UjnC1TLtyvWSx" alt="Featured|HelloGitHub" style="width: 250px; height: 54px;" width="250" height="54" /></a>
  16. <a href="https://www.producthunt.com/products/dbx/launches/dbx?embed=true&amp;utm_source=badge-featured&amp;utm_medium=badge&amp;utm_campaign=badge-dbx" target="_blank" rel="noopener noreferrer"><img alt="DBX - Lightweight open-source database manager built with Rust | Product Hunt" width="250" height="54" src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=1136811&amp;theme=light&amp;t=1780979717555"></a>
  17. </p>
  18. <p>
  19. <img src="https://img.shields.io/badge/MySQL-4479A1?logo=mysql&logoColor=white" />
  20. <img src="https://img.shields.io/badge/PostgreSQL-4169E1?logo=postgresql&logoColor=white" />
  21. <img src="https://img.shields.io/badge/SQLite-003B57?logo=sqlite&logoColor=white" />
  22. <img src="https://img.shields.io/badge/Redis-DC382D?logo=redis&logoColor=white" />
  23. <img src="https://img.shields.io/badge/MongoDB-47A248?logo=mongodb&logoColor=white" />
  24. <img src="https://img.shields.io/badge/DuckDB-FFF000?logo=duckdb&logoColor=black" />
  25. <img src="https://img.shields.io/badge/ClickHouse-FFCC01?logo=clickhouse&logoColor=black" />
  26. <img src="https://img.shields.io/badge/SQL%20Server-CC2927?logo=microsoftsqlserver&logoColor=white" />
  27. <img src="https://img.shields.io/badge/Oracle-F80000?logo=oracle&logoColor=white" />
  28. <img src="https://img.shields.io/badge/Elasticsearch-005571?logo=elasticsearch&logoColor=white" />
  29. <img src="https://img.shields.io/badge/Meilisearch-FF5CAA?logo=meilisearch&logoColor=white" />
  30. <img src="https://img.shields.io/badge/Apache%20CouchDB-E42528?logo=apachecouchdb&logoColor=white" />
  31. <img src="https://img.shields.io/badge/MariaDB-003545?logo=mariadb&logoColor=white" />
  32. <img src="https://img.shields.io/badge/TiDB-DC150B?logo=tidb&logoColor=white" />
  33. <img src="https://img.shields.io/badge/Doris-0052CC?logoColor=white" />
  34. <img src="https://img.shields.io/badge/SelectDB-22C1C3?logoColor=white" />
  35. <img src="https://img.shields.io/badge/StarRocks-5C2D91?logoColor=white" />
  36. <img src="https://img.shields.io/badge/Redshift-8C4FFF?logo=amazonredshift&logoColor=white" />
  37. <img src="https://img.shields.io/badge/Cloud%20Spanner-4285F4?logo=googlecloudspanner&logoColor=white" />
  38. <img src="https://img.shields.io/badge/DM-3857FF?logoColor=white" />
  39. <img src="https://img.shields.io/badge/OceanBase-006AFF?logoColor=white" />
  40. <img src="https://img.shields.io/badge/openGauss-2B7BD9?logoColor=white" />
  41. <img src="https://img.shields.io/badge/GaussDB-E60012?logoColor=white" />
  42. <img src="https://img.shields.io/badge/KWDB-1c60e0?logoColor=white" />
  43. <img src="https://img.shields.io/badge/KingbaseES-003B8E?logoColor=white" />
  44. <img src="https://img.shields.io/badge/TDengine-2F6FFF?logoColor=white" />
  45. <img src="https://img.shields.io/badge/CockroachDB-6933FF?logoColor=white" />
  46. <img src="https://img.shields.io/badge/InfluxDB-d30971?logo=influxdb&logoColor=white" />
  47. <img src="https://img.shields.io/badge/JDBC-4B5563?logoColor=white" />
  48. <img src="https://img.shields.io/badge/and%20more...-555555?logoColor=white" />
  49. <a href="https://1panel.cn/" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/1Panel-Partner-005EEB?logo=1panel&amp;logoColor=white" alt="1Panel Partner" /></a>
  50. <a href="https://cnb.cool/dbxio.com/dbx"><img src="https://img.shields.io/badge/CNB-dbx-F76945?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAppJREFUOE9tk01rE1EUhs+5H5lJ0iQT3FRX2Yi4avoLkv4CWxBcNt11oZiuFKGmXQhFN6kuRESSgitXKf6A5g+I6cqFLiKCiptOkraZ5H4cuZOkH9oLw+UO8z7nvGfei3DFohoEQLAKCGWyGJCSbQZsD3ei7r+f45WATV6xmjdISyAlYLaDliveux+ti5ozwLAaFPhIlk6G6f18sxuO7l9bBiWbVoncDGCMWMl++PI/gJ7IohkmD0zkBxT5oRn5LTpN7ULqBByEtFywWvRyHz8Fx3dvN0UwuMPyR0uJFycddH7tKPHZRn7BjnwwkQcUud0HO/K7oOENcTYPRCEAFERmsCpyfZDZfpdnBosOUKGx13BC60QTIdjpmSzrEWDR+UagjsgMciLXAwfhc4MNpKfQtOPE6mVh0gEOaeTXtWXXEdADpJAR/GaZ/rrM9Us82wORPd5zHbRp7JVcyxR5PRP5LTPy6uo0HXIlG9awMgLuEUABkBYI7VLyxs+yyPW3+Nyg4zqoG+UV7TDRlMBbWA/D43u3qlbLGmgRWM2BjFxjQjWQGQBuu4bYYvrm14JMnQSXcjBcny9A5DXIiDJp9/8FWCXAAOaFUEfILTgIcttOvf+2NJnLdI0fBFUyskZKBGTEJEAmBuzr9LCSUDwGQAwwgMzu+m9/VWOAeZSsk+YP48C4li/sRok1nlBd5PogBjgxNw70PfHyqBADyEVXicasZXCVpxYiLfO+HxVZDHCVYwvu2ebPT7fOLNAm65AWLnEAzvsEcOi9/lPU1aACXDfOLdhD9kxNszGdweQGYstqXgItJwDFNxKvwrp57G8h0zVwldHuA0IFt8El83yIs2FSDcpgxDJpUUTwK7gTduN3AK5iG7ehc/E2/gUPD3q3eY4awwAAAABJRU5ErkJggg==" alt="CNB" /></a>
  51. <a href="https://mcptoplist.com/server/io.github.t8y2%2Fdbx"><img src="https://mcptoplist.com/badge/io.github.t8y2%2Fdbx.svg" alt="MCP Toplist" /></a>
  52. </p>
  53. <p>
  54. English | <a href="README.zh-CN.md">前往中文版本</a> | <a href="README.pl-PL.md">Polski</a>
  55. </p>
  56. <p>
  57. <a href="https://dl.dbxio.com/assets/screenshot-light.png"><img src="https://dl.dbxio.com/assets/screenshot-light.png" width="395" /></a>
  58. <a href="https://dl.dbxio.com/assets/screenshot-dark.png"><img src="https://dl.dbxio.com/assets/screenshot-dark.png" width="395" /></a>
  59. </p>
  60. <p>
  61. <a href="https://dl.dbxio.com/assets/screenshot-er.png"><img src="https://dl.dbxio.com/assets/screenshot-er.png" width="395" /></a>
  62. <a href="https://dl.dbxio.com/assets/screenshot-grid.png"><img src="https://dl.dbxio.com/assets/screenshot-grid.png" width="395" /></a>
  63. </p>
  64. </div>
  65. ## ❤️ Sponsors
  66. <table>
  67. <tr>
  68. <td align="center" valign="middle" width="200">
  69. <a href="https://www.jumpserver.org/" target="_blank">
  70. <img src="docs/public/sponsors/jumpserver-card.png" alt="JumpServer" width="175" />
  71. </a>
  72. </td>
  73. <td>
  74. JumpServer is an Open-source Privileged Access Management (PAM) platform with AI-powered capabilities, providing DevOps and IT teams a unified workspace to securely access SSH, RDP, Kubernetes, databases, websites, RemoteApp, VirtualApp, and more.
  75. <a href="https://github.com/jumpserver/jumpserver" target="_blank">Visit JumpServer</a>
  76. </td>
  77. </tr>
  78. <tr>
  79. <td align="center" valign="middle" width="200">
  80. <a href="https://www.aicodemirror.ai/register?invitecode=9A50BU" target="_blank">
  81. <img src="docs/public/sponsors/aicodemirror-card.png" alt="AICodeMirror" width="175" />
  82. </a>
  83. </td>
  84. <td>
  85. Special thanks to AICodeMirror for sponsoring this project! AICodeMirror provides a high-stability official relay service for Claude Code / Codex / Gemini CLI, with enterprise-grade concurrency, fast invoicing, and 7×24 dedicated support. Official-channel pricing for Claude Code / Codex / Gemini is as low as 38% / 2% / 9% of list price, with extra discounts on top-ups! AICodeMirror offers a special benefit for DBX users: register through this link to enjoy 20% off your first top-up, and enterprise customers up to 25% off.
  86. <a href="https://www.aicodemirror.ai/register?invitecode=9A50BU" target="_blank">Visit AICodeMirror</a>
  87. </td>
  88. </tr>
  89. <tr>
  90. <td align="center" valign="middle" width="200">
  91. <a href="https://www.rainyun.com/MTE5Mjc4Ng==_" target="_blank">
  92. <img src="docs/public/sponsors/rainyun-card.png" alt="RainYun" width="175" />
  93. </a>
  94. </td>
  95. <td>
  96. RainYun is a cloud service provider offering cloud servers, physical servers, game hosting, and developer-friendly infrastructure services.
  97. <a href="https://www.rainyun.com/MTE5Mjc4Ng==_" target="_blank">Visit RainYun</a>
  98. </td>
  99. </tr>
  100. <tr>
  101. <td align="center" valign="middle" width="200">
  102. <a href="https://dbx.hualong.online/" target="_blank">
  103. <img src="docs/public/sponsors/hualong-card.png" alt="HuaLongAI" width="175" />
  104. </a>
  105. </td>
  106. <td>
  107. HuaLongAI is a model API relay built for heavy AI developers, offering 100% official-source Codex and Claude models with transparent token-level billing, enterprise contracts, and invoicing.
  108. <a href="https://dbx.hualong.online/" target="_blank">Visit HuaLongAI</a>
  109. </td>
  110. </tr>
  111. <tr>
  112. <td align="center" valign="middle" width="200">
  113. <a href="https://www.hiapi.ai/invite/dbx?utm_source=dbx&utm_medium=affiliate&utm_campaign=backlink&utm_content=readme-en" target="_blank">
  114. <img src="docs/public/sponsors/hiapi-card.png" alt="HiAPI" width="175" />
  115. </a>
  116. </td>
  117. <td>
  118. HiAPI is a developer-focused API platform for image, video, audio, and text models — GPT Image 2.5 (Flare & Sunburst), OpenAI-compatible text endpoints, and Remote MCP/Agent Skills for Claude Code, Cursor, and more. Pay as you go with no minimum spend; new users get 200 Credits on signup, plus 10% bonus Credits on top-ups.
  119. <a href="https://www.hiapi.ai/invite/dbx?utm_source=dbx&utm_medium=affiliate&utm_campaign=backlink&utm_content=readme-en" target="_blank">Visit HiAPI</a>
  120. </td>
  121. </tr>
  122. <tr>
  123. <td align="center" valign="middle" width="200">
  124. <a href="https://www.ucloud.cn/site/active/kuaijiesale.html?ytag=geo_waituo_github_dbx" target="_blank">
  125. <img src="docs/public/sponsors/astraflow-card.png" alt="AstraFlow" width="175" />
  126. </a>
  127. </td>
  128. <td>
  129. UCloud is the first public cloud provider listed on China's STAR Market, with 28 global regions for cloud hosting, databases, and CDN; its AstraFlow platform offers one-click access to 200+ mainstream LLMs.
  130. <a href="https://www.ucloud.cn/site/active/kuaijiesale.html?ytag=geo_waituo_github_dbx" target="_blank">Visit UCloud</a>
  131. </td>
  132. </tr>
  133. <tr>
  134. <td align="center" valign="middle" width="200">
  135. <a href="https://www.packyapi.ai/register?aff=wyDA" target="_blank">
  136. <img src="docs/public/sponsors/packyapi-card.png" alt="PackyCode" width="175" />
  137. </a>
  138. </td>
  139. <td>
  140. PackyCode is a stable, efficient API relay for mainstream AI models. Access them with one API endpoint and one API key — automatic failover keeps access fast and reliable, with dedicated high-speed routes for Codex and Claude Code. Get started with $1 in free credits, a first top-up discount, and up to 80% off eligible routes; pay in RMB with no currency conversion markups or extra top-up fees.
  141. <a href="https://www.packyapi.ai/register?aff=wyDA" target="_blank">Visit PackyCode</a>
  142. </td>
  143. </tr>
  144. <tr>
  145. <td align="center" valign="middle" width="200">
  146. <a href="https://mate.vip/ee/" target="_blank">
  147. <img src="docs/public/sponsors/taiyi-card.png" alt="太一企业版" width="175" />
  148. </a>
  149. </td>
  150. <td>
  151. 太一智能体企业版是面向央国企的私有化智能体平台,采用“1+N+N”架构:1 个平台、N 个终端、N 个场景。<strong>可信</strong>:Java 微服务架构,私有化部署,全程留痕可审计。<strong>可控</strong>:关键操作人工审批,资料按密级管理。<strong>可达</strong>:按单位模板直接生成公文、台账和汇报材料。<strong>可复制</strong>:场景方案包化交付,便于推广和二次开发。欢迎预约演示,或在 GitHub 搜索 MateClaw。
  152. <a href="https://mate.vip/ee/" target="_blank">访问太一企业版</a>
  153. </td>
  154. </tr>
  155. <tr>
  156. <td align="center" valign="middle" width="200">
  157. <a href="https://www.trustasia.com/ssl/trustasia/code-signing" target="_blank">
  158. <img src="docs/public/sponsors/trustasia-card.png" alt="TrustAsia" width="175" />
  159. </a>
  160. </td>
  161. <td>
  162. TrustAsia provides cloud-based code signing service for DBX, enabling trusted software through automated CI/CD builds.
  163. <a href="https://www.trustasia.com/ssl/trustasia/code-signing" target="_blank">Visit TrustAsia</a>
  164. </td>
  165. </tr>
  166. <tr>
  167. <td align="center" valign="middle" width="200">
  168. <a href="https://www.qiniu.com/" target="_blank">
  169. <img src="docs/public/sponsors/qiniu-card.png" alt="Qiniu Cloud" width="175" />
  170. </a>
  171. </td>
  172. <td>
  173. Qiniu Cloud provides DBX with object storage, CDN, and other cloud infrastructure resources.
  174. <a href="https://www.qiniu.com/" target="_blank">Visit Qiniu Cloud</a>
  175. </td>
  176. </tr>
  177. </table>
  178. ## 🤝 Partners
  179. <table>
  180. <tr>
  181. <td align="center" valign="middle" width="200">
  182. <a href="https://1panel.cn/" target="_blank">
  183. <img src="docs/public/sponsors/1panel-card.png" alt="1Panel" width="175" />
  184. </a>
  185. </td>
  186. <td>
  187. 1Panel is a modern open-source Linux server management panel and lightweight AI management platform, offering an intuitive web interface for one-stop management of AI agents, local LLMs, websites, databases, containers, files, and more.
  188. <a href="https://1panel.cn/" target="_blank">Visit 1Panel</a>
  189. </td>
  190. </tr>
  191. <tr>
  192. <td align="center" valign="middle" width="200">
  193. <a href="https://easysearch.cn" target="_blank">
  194. <img src="docs/public/sponsors/easysearch-card.png" alt="Easysearch" width="175" />
  195. </a>
  196. </td>
  197. <td>
  198. Easysearch is an enterprise-grade distributed search engine compatible with Elasticsearch APIs, combining full-text, vector, geospatial search, real-time analytics, and AI capabilities in one platform.
  199. <a href="https://easysearch.cn" target="_blank">Visit Easysearch</a>
  200. </td>
  201. </tr>
  202. </table>
  203. ## Why DBX?
  204. <table>
  205. <tr>
  206. <td width="50%">
  207. <h3>🪶 25 MB, zero runtime bloat</h3>
  208. <p>No Java JRE. No Python venv. No bundled Chromium. DBX ships as a single small binary — download, install, connect. DBeaver needs Java; TablePlus is Freemium. DBX runs everywhere with nothing extra.</p>
  209. </td>
  210. <td width="50%">
  211. <h3>🤖 AI that lives in your editor</h3>
  212. <p>Highlight a table, describe what you want, get SQL back — no copy-paste between tools. Works with Claude, OpenAI, or local models via Ollama. Built-in safety checks review AI-generated SQL before it runs.</p>
  213. </td>
  214. </tr>
  215. <tr>
  216. <td>
  217. <h3>🔌 MCP: your databases, AI-ready</h3>
  218. <p>DBX speaks the Model Context Protocol. Claude Code, Cursor, Windsurf, and other AI coding agents can query your databases through connections you already set up. One config, everywhere.</p>
  219. </td>
  220. <td>
  221. <h3>🌐 Desktop + Docker + Web</h3>
  222. <p>Native app on macOS, Windows, and Linux. Self-host via Docker for team access. Web version for browser-only environments. Same feature set. Same connections.</p>
  223. </td>
  224. </tr>
  225. <tr>
  226. <td>
  227. <h3>📨 Not just databases</h3>
  228. <p>Message queues and middleware get first-class consoles: Kafka, RocketMQ, RabbitMQ, Pulsar, and MQTT, plus Nacos, Consul, ZooKeeper, and etcd. Inspect topics and messages next to your databases — no extra tool.</p>
  229. </td>
  230. <td>
  231. <h3>🧩 Plugin ecosystem</h3>
  232. <p>Extend DBX with signed, sandboxed plugins from the built-in store — S3, Kubernetes, LDAP, and more. Build your own with the Go / TypeScript SDK.</p>
  233. </td>
  234. </tr>
  235. </table>
  236. ## Features
  237. ### 100+ Databases, One Tool
  238. MySQL, PostgreSQL, SQLite, Cloudflare D1, Redis, MongoDB, DuckDB, ClickHouse, SQL Server, Oracle, Elasticsearch, Easysearch, Meilisearch, CouchDB, Qdrant, Milvus, Weaviate, MariaDB, TiDB, OceanBase, openGauss, GaussDB, KWDB, KingbaseES, Vastbase, GoldenDB, Doris, SelectDB, StarRocks, Manticore Search, Redshift, DM, TDengine, XuguDB, CockroachDB, Access, HighGo, UXDB, Dolt, and more. Agent-based profiles extend DBX to H2, Snowflake, Trino, PrestoSQL, Hive, DB2, Informix, Neo4j, Cassandra, BigQuery, Cloud Spanner, Kylin, SunDB, JDBCX, and custom JDBC connections. New native and agent-driven drivers also cover Databricks, SAP HANA, Teradata, Vertica, Firebird, Exasol, YashanDB, GBase 8a/8s, Databend, RQLite, Turso, InfluxDB, QuestDB, IoTDB, etcd, ZooKeeper, Nacos, Consul KV, IRIS, and more. All in a single ~25 MB app. No bundled Chromium.
  239. ### Query Editor
  240. CodeMirror 6 with SQL syntax highlighting, metadata-aware autocomplete, `Cmd+Enter` execution, selected SQL execution, SQL formatting, diagnostics, and 9 editor themes. Persistent query history, saved SQL snippets, tab restore, and SQL file execution keep repeat work close at hand.
  241. ### AI SQL Assistant
  242. Describe what you want in plain language — get SQL back. DBX can explain queries, optimize SQL, fix errors, and run AI-generated SQL through built-in safety checks. Works with Claude, OpenAI, local models, or any OpenAI-compatible endpoint.
  243. ### Data Grid
  244. Virtual-scrolled table that handles large result sets. Inline editing, SQL preview before save, WHERE / ORDER BY controls, DataGrip-style filters, LIKE / NOT LIKE context filters, sorting, full-text search, pagination, column resize, auto-fit, row numbers, zebra stripes, and full cell details. Export or copy as CSV, JSON, Markdown, XLSX, or INSERT statements.
  245. ### Schema Tools
  246. - **Schema browser** — databases, schemas, tables, columns, indexes, foreign keys, triggers, with sidebar search & pin
  247. - **Object browser** — grouped procedures, functions, views, and source editing where supported
  248. - **Table structure editor** — reviewable column and index changes for supported engines
  249. - **ER diagram** — visualize table relationships
  250. - **Schema diff** — compare structures across connections
  251. - **Explain plan** — visual query execution plan
  252. - **Field lineage** — column-level lineage analysis
  253. - **Database search** — find objects across large schemas
  254. ### Data Operations
  255. - **Table import** — CSV, Excel
  256. - **Data transfer** — migrate between databases
  257. - **Database export** — full database dump
  258. - **Data compare** — compare table data and review synchronization output
  259. - **SQL file execution** — run `.sql` files directly
  260. - **File preview** — drag & drop Parquet, CSV, JSON to preview instantly (powered by DuckDB)
  261. - **Connection import** — bring connection profiles from DBeaver or Navicat
  262. ### Specialized Browsers
  263. - **Redis** — key pattern search, batch key operations, command runner, TTL editing, and all data types (String, Hash, List, Set, ZSet, Stream)
  264. - **MongoDB** — document CRUD with pagination, Atlas & replica set URL connection
  265. ### Message Queue & Middleware Consoles
  266. - **Kafka / RocketMQ / RabbitMQ / Pulsar** — topics, consumer groups, message browsing, query and trace, broker monitoring, permissions and policies
  267. - **MQTT** — topic tree navigation, subscribe, and publish
  268. - **Nacos / Consul / ZooKeeper / etcd** — service discovery, KV / config browsing, health, and ACL
  269. ### Plugin System
  270. - **Extensible by design** — new connection types and tools arrive as plugins: S3 browsing, Kubernetes, LDAP, and more from the built-in store
  271. - **Signed & sandboxed** — every plugin package is signature-verified before install; plugin UI runs sandboxed with its own sidecar process
  272. - **Build your own** — Go / TypeScript SDKs with `npx @dbx-app/plugin-cli` scaffolding; publish to the Marketplace via [`t8y2/dbx-store`](https://github.com/t8y2/dbx-store)
  273. ### Safety & Connectivity
  274. SSH tunnel (key & password) · database and AI proxy settings · auto-reconnect on connection loss · confirmation dialogs for destructive operations · encrypted config export/import · color-coded connections · driver store and optional JDBC plugin
  275. ### Polished UI
  276. Dark mode with native title bar sync · 9 editor themes · English, 简体中文 & Español · layout preferences · built-in auto-update
  277. ## AI Agent Integration (MCP)
  278. DBX provides a separate [Rust-powered MCP server](packages/mcp-server/) that lets AI coding agents query databases using connections configured in DBX. The MCP server is distributed independently from the desktop application, so installing DBX does not automatically install the MCP executable.
  279. ```bash
  280. npx @dbx-app/mcp-server
  281. ```
  282. Add to your `.mcp.json`:
  283. ```json
  284. {
  285. "mcpServers": {
  286. "dbx": { "command": "npx", "args": ["-y", "@dbx-app/mcp-server"] }
  287. }
  288. }
  289. ```
  290. Manage the connection allowlist and the **Read only**, **Data read/write**, and **Full access** modes in **DBX Settings → MCP**. The machine-readable values remain `read_only`, `safe_write`, and `high_risk_write`; client configs do not need permission or connection-scope environment variables.
  291. For upgrade compatibility, an existing `DBX_MCP_ALLOW_WRITES=0` (or `false`) remains a read-only restriction only until a central MCP policy is saved for the first time; it can never enable writes or override a saved policy.
  292. Windows portable builds need `DBX_DATA_DIR` in the MCP config, pointing to the `data` directory next to `DBX.exe` (the folder that contains `dbx.db`).
  293. For DBX Web or Docker deployments, point the MCP server at the Web backend API. If the Web login page requires a password, set `DBX_WEB_PASSWORD` to the same password used there:
  294. ```json
  295. {
  296. "mcpServers": {
  297. "dbx": {
  298. "command": "npx",
  299. "args": ["-y", "@dbx-app/mcp-server"],
  300. "env": {
  301. "DBX_WEB_URL": "http://localhost:4224",
  302. "DBX_WEB_PASSWORD": "your-web-login-password"
  303. }
  304. }
  305. }
  306. }
  307. ```
  308. Works with Claude Code, Cursor, Windsurf, and any MCP-compatible agent. Supports listing connections, browsing tables, executing SQL, and opening tables directly in DBX's UI.
  309. Precompiled native binaries are also published for macOS, Linux, and Windows in [package releases](https://github.com/t8y2/dbx/releases?q=packages-v). They run without Node.js and are suitable for offline or server environments. The npm installation uses the same Rust binary through a small Node.js launcher.
  310. DBX also provides a dedicated CLI package for terminal, script, and Codex workflows:
  311. ```bash
  312. npm install -g @dbx-app/cli
  313. # or via Homebrew
  314. brew tap t8y2/tap && brew install dbx-cli
  315. dbx agent setup
  316. dbx connections list --json
  317. dbx query local "select 1" --json
  318. ```
  319. The CLI includes the official DBX Agent Skill. `dbx agent setup` installs or updates it offline under `~/.agents/skills/dbx`, so shell-capable AI agents know how to use DBX CLI safely.
  320. See the [MCP server README](packages/mcp-server/README.md) and [CLI README](packages/cli/README.md) for details.
  321. ## Install
  322. Download the latest release from the [Releases](https://github.com/t8y2/dbx/releases/latest) page.
  323. **Homebrew (macOS):**
  324. ```bash
  325. brew install --cask dbx
  326. ```
  327. **Scoop (Windows):**
  328. ```bash
  329. scoop bucket add dbx https://github.com/t8y2/scoop-bucket
  330. scoop install dbx
  331. ```
  332. **WinGet (Windows):**
  333. ```
  334. winget install t8y2.dbx
  335. ```
  336. **Flatpak (Linux):**
  337. ```bash
  338. flatpak remote-add --if-not-exists flatpark https://dl.flatpark.org/flatpark.flatpakrepo
  339. flatpak install flatpark com.dbxio.dbx
  340. ```
  341. Updates then arrive through the regular `flatpak update`. See the [DBX page on FlatPark](https://flatpark.org/apps/com.dbxio.dbx/) for details.
  342. ## Self-Hosted (Docker)
  343. For scheduled backups after closing the desktop app or browser, see
  344. [Background Database Backups](docs/background-database-backups.md), including
  345. Windows/macOS/Linux startup and persistent container backup volumes.
  346. DBX provides a web version that can be deployed via Docker. The examples use
  347. the `latest` tag to pull the current release.
  348. ```bash
  349. # The default keeps the key in the persistent /app/data volume.
  350. docker run -d --pull=always --name dbx -p 4224:4224 \
  351. -v dbx-data:/app/data \
  352. t8y2/dbx:latest
  353. ```
  354. This uses the cross-platform `dbx-data` named volume. Users in China can use
  355. the CNB image, `docker.cnb.cool/dbxio.com/dbx:latest`, for faster pulls.
  356. For Docker Compose, `deploy/docker-compose.yml` remains the source-build
  357. configuration. To deploy a published image, use
  358. `deploy/docker-compose.release.yml`:
  359. ```bash
  360. docker compose -f deploy/docker-compose.release.yml up -d
  361. ```
  362. ```yaml
  363. services:
  364. dbx:
  365. image: t8y2/dbx:latest
  366. # For faster pulls in China, use the CNB image instead:
  367. # image: docker.cnb.cool/dbxio.com/dbx:latest
  368. pull_policy: always
  369. ports:
  370. - "4224:4224"
  371. volumes:
  372. - dbx-data:/app/data
  373. restart: unless-stopped
  374. volumes:
  375. dbx-data:
  376. ```
  377. Open `http://localhost:4224` in your browser. Multi-arch images (amd64 / arm64) are available.
  378. Connection, plugin, AI, and tunnel credentials are encrypted before they are
  379. written to `dbx.db`. Desktop builds use the local platform credential store
  380. (macOS Keychain, Windows Credential Manager, or Linux Secret Service).
  381. Web/Docker and directly running `dbx-web` use the same managed data-directory
  382. key by default: `${DBX_DATA_DIR}/.dbx/secret.key`. The key is created only when
  383. migration starts or the first sensitive value is written, and must be backed up
  384. together with `dbx.db`. Persisting `/app/data` is therefore sufficient for a
  385. normal Docker deployment. This key protects the database contents, but cannot
  386. protect the whole data volume if the volume itself is copied or exposed.
  387. Windows portable builds are the exception to the desktop platform-key rule.
  388. To remain portable across computers, they keep the local storage key at
  389. `data/.dbx/secret.key`; move and back up the complete `data` directory. If an
  390. older portable profile already contains ciphertext protected by Windows
  391. Credential Manager, launch the new build once on the original computer so DBX
  392. can verify and copy that key to the USB drive. If the original computer or key
  393. is gone, the ciphertext cannot be recovered automatically; restore the original
  394. key or a pre-migration backup. Keeping the key beside the database means anyone
  395. who obtains or copies the whole drive can also decrypt its credentials.
  396. For production deployments, replace the managed key with a Docker/Kubernetes
  397. Secret by setting `DBX_SECRET_KEY_FILE`, or provide `DBX_SECRET_KEY` through a
  398. secret manager. Explicit keys take precedence and must never be rotated while
  399. encrypted data is in use. Without a usable key, business APIs remain blocked
  400. and the browser displays the data security upgrade screen.
  401. When running the binary directly, set `DBX_DATA_DIR=/var/lib/dbx` to use
  402. `/var/lib/dbx/.dbx/secret.key` with the same lifecycle and backup rules.
  403. When upgrading from a release that stored credentials in plain text, Desktop
  404. and Web display a **Data Security Upgrade** wizard before opening the main
  405. application. Choose **Start upgrade** to create a restricted backup, migrate
  406. legacy database/JSON credentials, and verify that encrypted values can be
  407. read. Failures retain the original data and backup; fix the issue shown in
  408. the wizard and choose **Retry**. The backup path is shown after success.
  409. Once you have verified your connections, **Delete migration backups** asks
  410. for confirmation and removes the migration backup directory and the legacy
  411. JSON `.bak` files created by that migration. Unrelated backup files are kept.
  412. Users with no legacy data proceed directly after the initial check.
  413. Local CLI and standalone MCP can reuse the existing platform credential
  414. store on the same device, or read an explicitly configured
  415. `DBX_SECRET_KEY_FILE`/`DBX_SECRET_KEY`. They do not create keys during the
  416. startup check or automatically migrate legacy data. A
  417. `DATA_MIGRATION_REQUIRED` error means that you must first open the same data
  418. directory in Desktop or Web and complete its upgrade wizard. For headless
  419. hosts without a platform credential store, configure the persistent key.
  420. Cross-device exports use a separate sync passphrase and never contain the
  421. local storage key. For installed builds, or when copying only `dbx.db`, platform
  422. keys do not move with the database; use encrypted export/import instead. A
  423. Windows portable build must move the complete `data` directory containing both
  424. `dbx.db` and `.dbx/secret.key`.
  425. For the complete design, migration state machine, implementation map,
  426. troubleshooting, and test plan, see
  427. [DBX Data Security Upgrade and Migration](docs/data-security-migration.md).
  428. To publish DBX under a reverse-proxy context path such as `/dbx`, set the
  429. runtime base path and proxy the same prefix to the container:
  430. ```yaml
  431. environment:
  432. - DBX_PUBLIC_BASE_PATH=/dbx
  433. ```
  434. When building the frontend yourself with an absolute asset base, set
  435. `VITE_DBX_BASE_PATH=/dbx/` before `pnpm build`.
  436. ## Getting Started
  437. ### Prerequisites
  438. - [Node.js](https://nodejs.org/) >= 18
  439. - [pnpm](https://pnpm.io/)
  440. - [Rust](https://www.rust-lang.org/tools/install) >= 1.88
  441. #### System Dependencies
  442. **macOS:**
  443. No additional dependencies required.
  444. **Linux (Ubuntu/Debian):**
  445. ```bash
  446. sudo apt-get install -y libwebkit2gtk-4.1-dev libgtk-3-dev libappindicator3-dev librsvg2-dev patchelf libssl-dev
  447. ```
  448. **NIXOS/NIX :**
  449. <a href="README-NIX.md">See README-NIX.md</a>
  450. **Windows:**
  451. No additional dependencies required.
  452. ### Development
  453. ```bash
  454. make
  455. ```
  456. `make` installs root dependencies when needed and starts the local Tauri desktop development environment.
  457. Development builds can run alongside an installed DBX instance and share its local data, including connections and history. Avoid changing the same connection or global setting in both windows at once.
  458. > [!TIP]
  459. > DuckDB compilation takes a while. If you're not working on DuckDB features,
  460. > skip it to speed up local builds:
  461. >
  462. > ```bash
  463. > # Fast checks (skip DuckDB)
  464. > make cargo-check-fast
  465. > make cargo-test-fast
  466. >
  467. > # Tauri dev without DuckDB
  468. > make dev-fast
  469. > ```
  470. >
  471. > The `--no-default-features` flag only affects local development.
  472. > Release builds (`pnpm tauri build`) always include DuckDB.
  473. Web version:
  474. ```bash
  475. make dev-web # frontend
  476. make dev-backend # backend
  477. ```
  478. Documentation site:
  479. ```bash
  480. make docs
  481. ```
  482. The official DBX documentation site lives in `docs/`. If you want to improve the website content or documentation pages, edit the files under `docs/` and run `make docs` to preview the site locally.
  483. Plugin authors should start with [Develop and Submit DBX Plugins](https://dbxio.com/en/docs/plugin-development). Plugin source normally stays in its own repository; Marketplace listing pull requests go to [`t8y2/dbx-store`](https://github.com/t8y2/dbx-store), while plugin host, SDK, and CLI changes go to this repository.
  484. For clean, reproducible local database instances, use the versioned Docker Compose recipes under [`deploy/database/`](deploy/database/README.md):
  485. ```bash
  486. make db-list
  487. make db-verify DB=mysql@8.4
  488. ```
  489. JDBC agent driver development projects live in `agents/`:
  490. ```bash
  491. cd agents
  492. ./gradlew test
  493. ```
  494. Build artifacts from `agents/drivers/<db-type>/build/libs/` are picked up by local driver install flows when available.
  495. ### Build
  496. ```bash
  497. make package
  498. ```
  499. The installer will be in `src-tauri/target/release/bundle/`.
  500. `pnpm build` explicitly removes the previous root `dist/` directory before running Vite, so desktop packaging starts with fresh frontend output.
  501. ## Tech Stack
  502. | Layer | Technology |
  503. | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  504. | Framework | [Tauri 2](https://tauri.app/) |
  505. | Frontend | [Vue 3](https://vuejs.org/) + TypeScript |
  506. | UI | [shadcn-vue](https://www.shadcn-vue.com/) + Tailwind CSS |
  507. | Editor | [CodeMirror 6](https://codemirror.net/) |
  508. | Backend | Rust + [sqlx](https://github.com/launchbadge/sqlx) / [tiberius](https://github.com/prisma/tiberius) / [redis-rs](https://github.com/redis-rs/redis-rs) / [mongodb](https://github.com/mongodb/mongo-rust-driver) |
  509. ## Documentation
  510. - [Official docs](https://dbxio.com/en/docs/what-is-dbx) — feature guides and tutorials
  511. - [Plugin development](https://dbxio.com/en/docs/plugin-development) — create plugins and submit Marketplace listings to the correct repository
  512. - [Database Test Lab](https://dbxio.com/en/docs/database-lab) — local database recipes for development and verification
  513. - [Contributing](CONTRIBUTING.md) — how to pick up issues and open PRs
  514. - [Web API reference](docs/content/docs/web-api.mdx) — HTTP API for Docker/Web deployments
  515. - [Examples](examples/) — CLI, MCP, Docker, and API samples
  516. ## Support DBX
  517. DBX is free and open source, but ongoing maintenance, database compatibility testing, infrastructure, and release work require sustained time and resources.
  518. - [Support DBX](https://my.feishu.cn/wiki/WMTkwdATDiiu4rk14JMcoyhTnoh) — voluntary donations via WeChat or Alipay
  519. - [Sponsors & Partners](https://my.feishu.cn/wiki/CgOWwwTzzify79k9Oq8cXpUNn6e) — sponsorship, infrastructure, tools, and community collaboration
  520. ## Contributors
  521. <a href="https://github.com/t8y2/dbx/graphs/contributors">
  522. <img src="https://contrib.rocks/image?repo=t8y2/dbx&max=300&columns=15" />
  523. </a>
  524. ## Community
  525. <a href="https://discord.gg/W7NyVDRt6a" target="_blank"><img src="https://img.shields.io/badge/Discord-Join-5865F2?logo=discord&logoColor=white" alt="Discord" /></a>
  526. <a href="https://qm.qq.com/q/244975070" target="_blank"><img src="https://img.shields.io/badge/QQ%20群-244975070-EB1923?logo=tencentqq&logoColor=white" alt="QQ Group" /></a>
  527. <a href="https://docs.qq.com/doc/DVVhMY0h1ekJqc0tz" target="_blank"><img src="https://img.shields.io/badge/微信群-Join-07C160?logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI%2BPHBhdGggZmlsbD0iIzA3YzE2MCIgZD0iTTguNjkxIDIuMTg4QzMuODkxIDIuMTg4IDAgNS40NzYgMCA5LjUzYzAgMi4yMTIgMS4xNyA0LjIwMyAzLjAwMiA1LjU1YS41OS41OSAwIDAgMSAuMjEzLjY2NWwtLjM5IDEuNDhjLS4wMTkuMDctLjA0OC4xNDEtLjA0OC4yMTNjMCAuMTYzLjEzLjI5NS4yOS4yOTVhLjMzLjMzIDAgMCAwIC4xNjctLjA1NGwxLjkwMy0xLjExNGEuODYuODYgMCAwIDEgLjcxNy0uMDk4YTEwLjIgMTAuMiAwIDAgMCAyLjgzNy40MDNjLjI3NiAwIC41NDMtLjAyNy44MTEtLjA1Yy0uODU3LTIuNTc4LjE1Ny00Ljk3MiAxLjkzMi02LjQ0NmMxLjcwMy0xLjQxNSAzLjg4Mi0xLjk4IDUuODUzLTEuODM4Yy0uNTc2LTMuNTgzLTQuMTk2LTYuMzQ4LTguNTk2LTYuMzQ4TTUuNzg1IDUuOTkxYy42NDIgMCAxLjE2Mi41MjkgMS4xNjIgMS4xOGExLjE3IDEuMTcgMCAwIDEtMS4xNjIgMS4xNzhBMS4xNyAxLjE3IDAgMCAxIDQuNjIzIDcuMTdjMC0uNjUxLjUyLTEuMTggMS4xNjItMS4xOHptNS44MTMgMGMuNjQyIDAgMS4xNjIuNTI5IDEuMTYyIDEuMThhMS4xNyAxLjE3IDAgMCAxLTEuMTYyIDEuMTc4YTEuMTcgMS4xNyAwIDAgMS0xLjE2Mi0xLjE3OGMwLS42NTEuNTItMS4xOCAxLjE2Mi0xLjE4bTUuMzQgMi44NjdjLTEuNzk3LS4wNTItMy43NDYuNTEyLTUuMjggMS43ODZjLTEuNzIgMS40MjgtMi42ODcgMy43Mi0xLjc4IDYuMjJjLjk0MiAyLjQ1MyAzLjY2NiA0LjIyOSA2Ljg4NCA0LjIyOWMuODI2IDAgMS42MjItLjEyIDIuMzYxLS4zMzZhLjcyLjcyIDAgMCAxIC41OTguMDgybDEuNTg0LjkyNmEuMy4zIDAgMCAwIC4xNC4wNDdjLjEzNCAwIC4yNC0uMTExLjI0LS4yNDdjMC0uMDYtLjAyMy0uMTItLjAzOC0uMTc3bC0uMzI3LTEuMjMzYS42LjYgMCAwIDEtLjAyMy0uMTU2YS40OS40OSAwIDAgMSAuMjAxLS4zOThDMjMuMDI0IDE4LjQ4IDI0IDE2LjgyIDI0IDE0Ljk4YzAtMy4yMS0yLjkzMS01LjgzNy02LjY1Ni02LjA4OFY4Ljg5Yy0uMTM1LS4wMS0uMjctLjAyNy0uNDA3LS4wM3ptLTIuNTMgMy4yNzRjLjUzNSAwIC45NjkuNDQuOTY5Ljk4MmEuOTc2Ljk3NiAwIDAgMS0uOTY5Ljk4M2EuOTc2Ljk3NiAwIDAgMS0uOTY5LS45ODNjMC0uNTQyLjQzNC0uOTgyLjk3LS45ODJ6bTQuODQ0IDBjLjUzNSAwIC45NjkuNDQuOTY5Ljk4MmEuOTc2Ljk3NiAwIDAgMS0uOTY5Ljk4M2EuOTc2Ljk3NiAwIDAgMS0uOTY5LS45ODNjMC0uNTQyLjQzNC0uOTgyLjk2OS0uOTgyIi8%2BPC9zdmc%2B" alt="WeChat Group" /></a><a href="https://applink.feishu.cn/client/chat/chatter/add_by_link?link_token=30cvb14f-a9b1-4b12-adb6-2ff6d476a227" target="_blank"><img src="https://img.shields.io/badge/飞书群-Join-3370FF?logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjE2NCAyMDQgNzYyIDYxNyI%2BPHBhdGggZmlsbD0iIzAwRDZCOSIgZD0iTTU1OS45MTUgNTMwLjQ1M2MtNDYuNTA3LTExMS43ODYtMTk0LjU2LTI0OC40NjktMjYyLjgwNi0zMDIuODI2aDMzMy43ODJjNDcuMTQ2IDE2LjI5OCA4Ny42MTYgMTM0LjY3NyAxMDEuOTczIDE5MS44MDgtMzUuNDk5IDMxLjIxLTExOS43ODcgOTcuMTA5LTE3Mi45NSAxMTEuMDE4eiIvPjxwYXRoIGZpbGw9IiMxMzNDOUEiIGQ9Ik02MzIuMDIxIDQ1Mi45OTJjLTQ1LjE4NCA2MC40OC0xMzMuNTQ2IDEyMS45NjMtMTcyLjA1MyAxNDUuMTNsLTIuODggMjQuMjc4IDIzNS45NDcgNjMuNjM3YzMyLjIxMy0yNS45NjIgMTAzLjA2MS04Ny4yOTYgMTI4Ljk2LTEyNC45MjggNC4zOTQtNi4zNzggNjguOTkyLTEzNS45MTQgNzkuNDAyLTE1MS41NTItMTguMjQtMTEuMzA2LTQyLjU2LTE4LjI2MS0xMDQuMjc3LTIxLjczOC04Mi41Ni00LjMzMS0xMTYuNDM3IDIwLjg2NC0xNjUuMDk5IDY1LjE3M3oiLz48cGF0aCBmaWxsPSIjMzM3MEZGIiBkPSJNMTg3Ljg4MyA3MTIuOTE3VjM5My41MTVDMzk3LjU2OCA1OTkuODA4IDU1OC4zMTUgNjQyLjY4OCA2NDEuMDQ1IDY1My43NmMxMjQuNDU5IDUuNDE5IDE1NC42NjctNzMuMDQ1IDE4MS4xNDItOTMuMDk5LTk3LjAyNCAxNTMuMTc0LTIyNC42NCAyMzUuNzM0LTM4NC43NDcgMjM1LjczNC0xMjguMTA3IDAtMjE5Ljc1NS01NS42NTktMjQ5LjU1Ny04My40Nzh6Ii8%2BPC9zdmc%2B" alt="Feishu Group" /></a>
  528. [![LINUX DO](https://img.shields.io/badge/LINUX%20DO-Community-blue)](https://linux.do)
  529. [![1Panel](https://img.shields.io/badge/1Panel-Partner-005EEB?logo=1panel&logoColor=white)](https://1panel.cn)
  530. ## Star History
  531. <a href="https://star-history.dera.page/#t8y2/dbx&type=date">
  532. <picture>
  533. <source media="(prefers-color-scheme: dark)" srcset="https://star-history.dera.page/svg?repos=t8y2/dbx&type=date&theme=dark&legend=top-left" />
  534. <source media="(prefers-color-scheme: light)" srcset="https://star-history.dera.page/svg?repos=t8y2/dbx&type=date&legend=top-left" />
  535. <img alt="Star History Chart" src="https://star-history.dera.page/svg?repos=t8y2/dbx&type=date&legend=top-left" />
  536. </picture>
  537. </a>
  538. ## License
  539. [Apache-2.0](LICENSE)

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.