Conar.app

Conar 是一个基于 AI 的开源项目，旨在简化数据库交互。它专为 PostgreSQL、MySQL、MSSQL 和 ClickHouse 构建，并计划在不久的将来支持更多数据库。您可以在我们的云端安全地存储数据库连接，并让 AI 帮助您编写和优化 SQL 查询。

功能特性

• 🔐 安全且开放

  • 开源代码库
  • 加密的连接字符串
  • 密码保护

• 💾 多数据库支持

  • PostgreSQL
  • MySQL
  • MSSQL
  • ClickHouse
  • SQLite（即将支持）
  • MongoDB（即将支持）

• 🤖 AI 驱动的功能

  • 智能 SQL 辅助
  • 可切换 AI 模型
  • 更多功能敬请期待……

技术栈

• React + TypeScript
• Electron
• TailwindCSS 和 shadcn/ui
• Vite
• TanStack Start/Router/Query/Form/Virtual
• Arktype
• Bun
• Hono
• oRPC
• Drizzle ORM
• Better Auth
• 包含 Anthropic、OpenAI、Gemini 和 XAI 的 AI SDK
• Railway
• PostHog
• Resend
• ToDesktop
• Stripe

开发环境搭建

• 📦 安装依赖

  pnpm install
  

• 🐳 使用 Docker Compose 启动数据库

  这将后台启动 PostgreSQL 数据库和 Redis。

  pnpm run docker:start
  

• 🗄️ 准备数据库

  这将执行数据库迁移，以设置所需的表和模式。

  pnpm run drizzle:migrate
  

• 🚀 运行项目

  这将使用 Turbo 启动所有开发服务器。

  pnpm run dev
  

测试

• 单元测试

  pnpm run test:unit
  

在运行端到端测试之前，请确保先启动测试服务器：pnpm run test:start，并准备好数据库 postgresql://postgres:postgres@localhost:5432/conar。

• E2E 测试

  pnpm run test:e2e
  

Conar 快速上手指南

Conar 是一款开源的 AI 驱动数据库管理工具，支持 PostgreSQL、MySQL、MSSQL 和 ClickHouse。它允许你将连接信息加密存储，并利用 AI 辅助编写和优化 SQL 查询。

环境准备

在开始之前，请确保你的开发环境满足以下要求：

• 操作系统：Windows, macOS 或 Linux
• Node.js 环境：推荐安装最新 LTS 版本
• 包管理器：必须安装 pnpm (项目基于 pnpm 构建)
• 容器运行时：安装 Docker 及 Docker Compose（用于本地数据库依赖）
• 代码编辑器：推荐 VS Code

国内开发者提示：如果下载 Node.js 或 pnpm 较慢，建议使用国内镜像源（如淘宝镜像或清华大学开源软件镜像站）进行安装。

安装步骤

克隆项目后，在终端中依次执行以下命令完成环境搭建：

1. 安装项目依赖

   pnpm install
   

2. 启动本地数据库服务 此命令将在后台启动 PostgreSQL 数据库和 Redis 服务。

   pnpm run docker:start
   

3. 初始化数据库架构 运行迁移脚本以创建必要的表结构和 Schema。

   pnpm run drizzle:migrate
   

4. 启动开发服务器 使用 Turbo 启动所有开发服务（包括前端、后端等）。

   pnpm run dev
   

基本使用

启动成功后，Conar 桌面应用或开发界面将自动打开（取决于具体配置）。以下是核心工作流程：

1. 配置数据库连接

   • 在界面中选择支持的数据库类型（PostgreSQL, MySQL, MSSQL, ClickHouse）。
   • 输入连接字符串。Conar 会对连接信息进行加密存储，保障安全。

2. 使用 AI 辅助查询

   • 连接到数据库后，在查询编辑器中输入自然语言描述（例如：“查找过去 7 天订单量最高的用户”）。
   • Conar 集成的 AI 模型（支持 Anthropic, OpenAI, Gemini 等）将自动生成对应的 SQL 语句。
   • 你可以直接运行生成的 SQL，或让 AI 进一步优化查询性能。

3. 切换 AI 模型

   • 在设置中可根据需求切换不同的底层 AI 提供商，以获得最佳的代码生成效果。

---

注：如需运行单元测试，可执行 pnpm run test:unit；运行 E2E 测试前请先执行 pnpm run test:start 并确保本地数据库地址为 postgresql://postgres:postgres@localhost:5432/conar。