Skip to content

armgit / dbx

Public Imported from GitHub
0

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。

1.3 KB
Raw Blame

DBX Examples

Runnable samples for common DBX workflows.

Directory What it shows
cli/ Terminal queries with @dbx-app/cli
mcp/ MCP configs for Cursor and Claude Code
docker/ Self-hosted Docker deployment
web-api/ Minimal HTTP API automation against DBX Web

Before You Run

  1. Install DBX Desktop, or start the Docker/Web version.
  2. Create at least one connection in DBX.
  3. For CLI examples, install the CLI:
npm install -g @dbx-app/cli
  1. For MCP examples, install the MCP server:
npm install -g @dbx-app/mcp-server

MCP connection access and execution permissions are configured centrally in DBX Settings → MCP. The client examples intentionally contain no permission or connection-scope environment variables.

Suggested Learning Path

  1. Read Getting Started
  2. Try the CLI workflow in cli/basic-workflow.sh
  3. Copy an MCP config from mcp/ into your project
  4. If you self-host DBX, use docker/docker-compose.yml
  5. For custom integrations, inspect web-api/automation.sh

More docs: