mirror of
https://github.com/t8y2/dbx.git
synced 2026-10-19 16:16:45 +00:00
docs: update README with full feature list and high-res logo
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
<div align="center">
|
||||
<img src="public/favicon.png" width="80" />
|
||||
<img src="docs/logo.png" width="80" />
|
||||
<h1>DBX</h1>
|
||||
<p>Open-source, lightweight, cross-platform database management tool.</p>
|
||||
<p>
|
||||
@@ -11,6 +11,8 @@
|
||||
<img src="https://img.shields.io/badge/DuckDB-FFF000?logo=duckdb&logoColor=black" />
|
||||
<img src="https://img.shields.io/badge/ClickHouse-FFCC01?logo=clickhouse&logoColor=black" />
|
||||
<img src="https://img.shields.io/badge/SQL%20Server-CC2927?logo=microsoftsqlserver&logoColor=white" />
|
||||
<img src="https://img.shields.io/badge/MariaDB-003545?logo=mariadb&logoColor=white" />
|
||||
<img src="https://img.shields.io/badge/TiDB-DC150B?logo=tidb&logoColor=white" />
|
||||
</p>
|
||||
<p>
|
||||
English | <a href="README.zh-CN.md">简体中文</a>
|
||||
@@ -19,20 +21,22 @@
|
||||
|
||||
## Features
|
||||
|
||||
- **8 databases** — MySQL, PostgreSQL, SQLite, Redis, MongoDB, DuckDB, ClickHouse, SQL Server
|
||||
- **Multi-database** — MySQL, PostgreSQL, SQLite, Redis, MongoDB, DuckDB, ClickHouse, SQL Server, MariaDB, TiDB, OceanBase, openGauss, GaussDB, KingBase, Vastbase, GoldenDB
|
||||
- **Schema browser** — Databases, schemas, tables, columns, indexes, foreign keys, triggers
|
||||
- **Query editor** — CodeMirror with syntax highlighting, auto-complete, Cmd+Enter execution
|
||||
- **Data grid** — Virtual-scrolled table with inline editing, sorting, pagination, column resize
|
||||
- **Query editor** — CodeMirror 6 with syntax highlighting, Cmd+Enter execution, Cmd+scroll zoom
|
||||
- **AI SQL assistant** — Natural language to SQL, explain, optimize, fix errors (Claude / OpenAI)
|
||||
- **Data grid** — Virtual-scrolled table with inline editing, sorting, search, pagination, column resize, row numbers, zebra stripes
|
||||
- **Export** — CSV, JSON, Markdown
|
||||
- **Redis browser** — Key pattern search, value viewer for all data types
|
||||
- **Redis browser** — Key pattern search, value viewer for all data types (String, Hash, List, Set, ZSet)
|
||||
- **MongoDB browser** — Document CRUD with pagination
|
||||
- **Query history** — Persistent history with search, restore, and one-click copy
|
||||
- **Query history** — Persistent history with search, restore, one-click copy
|
||||
- **Safety** — Confirmation dialog for DROP / DELETE / TRUNCATE / ALTER
|
||||
- **Auto-reconnect** — Transparent retry on connection loss
|
||||
- **SSH tunnel** — Connect through SSH port forwarding
|
||||
- **Dark mode** — System-aware theme toggle
|
||||
- **SSH tunnel** — Key and password authentication
|
||||
- **File drag & drop** — Drag .db / .sqlite / .duckdb files to open directly
|
||||
- **Dark mode** — Native title bar theme sync
|
||||
- **i18n** — English & 简体中文
|
||||
- **Tiny** — ~7 MB installer (no bundled Chromium)
|
||||
- **Tiny** — ~15 MB installer (no bundled Chromium)
|
||||
|
||||
## Screenshot
|
||||
|
||||
@@ -40,6 +44,20 @@
|
||||
<img src="docs/screenshot.png" width="800" />
|
||||
</div>
|
||||
|
||||
## Install
|
||||
|
||||
Download the latest release from the [Releases](https://github.com/t8y2/dbx/releases) page.
|
||||
|
||||
### macOS Note
|
||||
|
||||
DBX is not signed with an Apple Developer certificate. On first launch, macOS will block the app. To fix this:
|
||||
|
||||
```bash
|
||||
xattr -cr /Applications/dbx.app
|
||||
```
|
||||
|
||||
Or: **System Settings → Privacy & Security → Open Anyway**.
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
@@ -63,20 +81,6 @@ pnpm tauri build
|
||||
|
||||
The installer will be in `src-tauri/target/release/bundle/`.
|
||||
|
||||
## Install
|
||||
|
||||
Download the latest release from the [Releases](https://github.com/t8y2/dbx/releases) page.
|
||||
|
||||
### macOS Note
|
||||
|
||||
DBX is not signed with an Apple Developer certificate. On first launch, macOS will block the app. To fix this:
|
||||
|
||||
```bash
|
||||
xattr -cr /Applications/dbx.app
|
||||
```
|
||||
|
||||
Or: **System Settings → Privacy & Security → Open Anyway**.
|
||||
|
||||
## Tech Stack
|
||||
|
||||
| Layer | Technology |
|
||||
|
||||
+26
-22
@@ -1,5 +1,5 @@
|
||||
<div align="center">
|
||||
<img src="public/favicon.png" width="80" />
|
||||
<img src="docs/logo.png" width="80" />
|
||||
<h1>DBX</h1>
|
||||
<p>开源、轻量、跨平台的数据库管理工具。</p>
|
||||
<p>
|
||||
@@ -11,6 +11,8 @@
|
||||
<img src="https://img.shields.io/badge/DuckDB-FFF000?logo=duckdb&logoColor=black" />
|
||||
<img src="https://img.shields.io/badge/ClickHouse-FFCC01?logo=clickhouse&logoColor=black" />
|
||||
<img src="https://img.shields.io/badge/SQL%20Server-CC2927?logo=microsoftsqlserver&logoColor=white" />
|
||||
<img src="https://img.shields.io/badge/MariaDB-003545?logo=mariadb&logoColor=white" />
|
||||
<img src="https://img.shields.io/badge/TiDB-DC150B?logo=tidb&logoColor=white" />
|
||||
</p>
|
||||
<p>
|
||||
<a href="README.md">English</a> | 简体中文
|
||||
@@ -19,20 +21,22 @@
|
||||
|
||||
## 功能特性
|
||||
|
||||
- **8 种数据库** — MySQL、PostgreSQL、SQLite、Redis、MongoDB、DuckDB、ClickHouse、SQL Server
|
||||
- **多数据库** — MySQL、PostgreSQL、SQLite、Redis、MongoDB、DuckDB、ClickHouse、SQL Server、MariaDB、TiDB、OceanBase、openGauss、GaussDB、KingBase、Vastbase、GoldenDB
|
||||
- **结构浏览** — 数据库、Schema、表、字段、索引、外键、触发器
|
||||
- **查询编辑器** — CodeMirror 语法高亮、自动补全、Cmd+Enter 执行
|
||||
- **数据表格** — 虚拟滚动、行内编辑、排序、分页、列宽调整
|
||||
- **查询编辑器** — CodeMirror 6 语法高亮、Cmd+Enter 执行、Cmd+滚轮缩放
|
||||
- **AI SQL 助手** — 自然语言生成 SQL、解释、优化、修复错误(Claude / OpenAI)
|
||||
- **数据表格** — 虚拟滚动、行内编辑、排序、搜索、分页、列宽调整、行号、斑马纹
|
||||
- **数据导出** — CSV、JSON、Markdown
|
||||
- **Redis 浏览器** — 模式匹配搜索,支持全部数据类型查看
|
||||
- **Redis 浏览器** — 模式匹配搜索,支持全部数据类型(String、Hash、List、Set、ZSet)
|
||||
- **MongoDB 浏览器** — 文档增删改查、分页浏览
|
||||
- **查询历史** — 持久化存储,支持搜索、恢复、一键复制
|
||||
- **安全防护** — 执行 DROP / DELETE / TRUNCATE / ALTER 时弹出确认对话框
|
||||
- **自动重连** — 连接断开后透明重试
|
||||
- **SSH 隧道** — 通过 SSH 端口转发连接数据库
|
||||
- **深色模式** — 明暗主题一键切换
|
||||
- **SSH 隧道** — 支持密钥和密码两种认证方式
|
||||
- **文件拖放** — 拖拽 .db / .sqlite / .duckdb 文件到窗口直接打开
|
||||
- **深色模式** — 原生标题栏主题同步
|
||||
- **多语言** — English & 简体中文
|
||||
- **极致轻量** — 安装包仅 ~7 MB(不内嵌 Chromium)
|
||||
- **极致轻量** — 安装包约 15 MB(不内嵌 Chromium)
|
||||
|
||||
## 截图
|
||||
|
||||
@@ -40,6 +44,20 @@
|
||||
<img src="docs/screenshot.png" width="800" />
|
||||
</div>
|
||||
|
||||
## 安装
|
||||
|
||||
从 [Releases](https://github.com/t8y2/dbx/releases) 页面下载最新版本。
|
||||
|
||||
### macOS 说明
|
||||
|
||||
DBX 未使用 Apple 开发者证书签名,首次打开时 macOS 会阻止运行。解决方法:
|
||||
|
||||
```bash
|
||||
xattr -cr /Applications/dbx.app
|
||||
```
|
||||
|
||||
或者:**系统设置 → 隐私与安全性 → 仍要打开**。
|
||||
|
||||
## 快速开始
|
||||
|
||||
### 环境要求
|
||||
@@ -63,20 +81,6 @@ pnpm tauri build
|
||||
|
||||
安装包输出在 `src-tauri/target/release/bundle/` 目录。
|
||||
|
||||
## 安装
|
||||
|
||||
从 [Releases](https://github.com/t8y2/dbx/releases) 页面下载最新版本。
|
||||
|
||||
### macOS 说明
|
||||
|
||||
DBX 未使用 Apple 开发者证书签名,首次打开时 macOS 会阻止运行。解决方法:
|
||||
|
||||
```bash
|
||||
xattr -cr /Applications/dbx.app
|
||||
```
|
||||
|
||||
或者:**系统设置 → 隐私与安全性 → 仍要打开**。
|
||||
|
||||
## 技术栈
|
||||
|
||||
| 层级 | 技术 |
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 31 KiB |
Reference in New Issue
Block a user