# db-tools

**Repository Path**: summer-wind/db-tools

## Basic Information

- **Project Name**: db-tools
- **Description**: 一个AI数据库管理软件，用对话使用数据库
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-21
- **Last Updated**: 2026-06-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OpenDB

AI-native local-first database client — Electron + React + Go.

## Architecture

```
desktop/     Electron + React UI
agent/       Go sidecar (DB drivers + AI orchestration)
skills/      File-driven SKILL.md capabilities
docs/        Requirements + design (dev + ui)
legacy/      Archived Flutter client (reference only)
```

## Development

```bash
# Build agent + run Electron dev server
./dev.sh
```

Requires: Node 20+, Go 1.25+. Primary development on macOS; Windows and Linux installers can be built from macOS (Windows NSIS requires Wine).

## Release

### macOS (signed + notarized DMG)

```bash
./dev.sh release-dist
```

Output: `dist/OpenDB-{version}.dmg`

### Cross-platform installers

Build all platforms (macOS dmg+zip, Windows NSIS+zip, Linux AppImage+deb):

```bash
./dev.sh release-all
```

Build a single platform:

```bash
./dev.sh release-platform mac
./dev.sh release-platform win    # requires Wine on macOS
./dev.sh release-platform linux
```

Or from `desktop/` after staging agents via `scripts/release/build-agent.sh`:

```bash
cd desktop && npm run electron:build:mac
cd desktop && npm run electron:build:win
cd desktop && npm run electron:build:linux
```

| Platform | Formats | Output directory |
|----------|---------|------------------|
| macOS | `.dmg`, `.zip` | `dist/` |
| Windows | NSIS `.exe`, `.zip` | `dist/` |
| Linux | `.AppImage`, `.deb` | `dist/` |

## Website

Product landing page (Chinese, static): [`website/`](website/). Deploy to Vercel or Cloudflare Pages with root directory `website`. See [`website/README.md`](website/README.md).

## Stack

| Layer | Tech |
|-------|------|
| Desktop UI | Electron 34, React 18, TypeScript, Tailwind |
| Backend | Go, Gin, OpenAI-compatible LLM |
| Skills | `skills/**/SKILL.md` hot-loaded by agent |
| Docs | `docs/requirements/` + `docs/design/` |

## Docs

- [Documentation index](docs/README.md)
- [AI workflow](.cursor/README.md) — `/prd` → `/tech-design` → `/ui-design` → `/develop` → `/verify`
- [Product PRD](docs/requirements/product/opendb-ai-prd.md)
- [Task progress](docs/requirements/TASKS.md)
- [Desktop shell design](docs/design/dev/desktop/shell.md)
- [Agent API](docs/design/dev/agent/ai-api.md)
- [UI mockups](docs/design/ui/)