DB-GPT README

The project's README from github.com/eosphoros-ai/DB-GPT. As one markdown file: README.md.

Logo DB-GPT: Open-Source Agentic AI Data Assistant

stars forks Official Website License: MIT Release Notes Open Issues X (formerly Twitter) Follow Medium Follow Bilibili Space Slack Open in GitHub Codespaces

English 简体中文 日本語

Documents | Contact Us | Community | Paper

An open-source AI data assistant that connects to your data, writes SQL and code, runs skills in sandboxed environments, and turns analysis into reports, insights, and action.

welcome_page

What is DB-GPT?

DB-GPT is an open-source agentic AI data assistant for the next generation of AI + Data products.

It helps users and teams:

DB-GPT is also a platform for building AI-native data agents, workflows, and applications with agents, AWEL, RAG, and multi-model support.

Why DB-GPT?

1. Agentic data analysis

Plan tasks, break work into steps, call tools, and complete analysis workflows end to end. csv_data_analysis_demo_en

2. Autonomous SQL + code execution

Generate SQL and code to query data, clean datasets, compute metrics, and produce outputs. agentic_write_code sql_query

3. Multi-source data access

Work across structured and unstructured sources, including databases, spreadsheets, documents, and knowledge bases.

datasource

4. Skills-driven extensibility

Package domain knowledge, analysis methods, and execution workflows into reusable skills.

import_github_skill

5. Sandboxed execution

Run code and tools in isolated environments for safer, more reliable analysis. sandbox

What you can do with DB-GPT

Product Workflow

Explore data

Connect files, databases, and knowledge bases in one workspace.

Plan and execute

Let AI reason through the task, write SQL and code, and execute step by step.

Use skills

Load reusable skills for repeatable business analysis workflows.

Generate reports

Produce charts, dashboards, HTML reports, and decision-ready outputs.

Quick Start

Get DB-GPT running in minutes with the one-line installer (macOS & Linux):

curl -fsSL https://raw.githubusercontent.com/eosphoros-ai/DB-GPT/main/scripts/install/install.sh | bash

Or specify a profile and API key directly:

curl -fsSL https://raw.githubusercontent.com/eosphoros-ai/DB-GPT/main/scripts/install/install.sh \
  | OPENAI_API_KEY=sk-xxx bash -s -- --profile openai

For Kimi 2.5 via Moonshot API:

curl -fsSL https://raw.githubusercontent.com/eosphoros-ai/DB-GPT/main/scripts/install/install.sh \
  | MOONSHOT_API_KEY=sk-xxx bash -s -- --profile kimi

For MiniMax via the OpenAI-compatible API:

curl -fsSL https://raw.githubusercontent.com/eosphoros-ai/DB-GPT/main/scripts/install/install.sh \
  | MINIMAX_API_KEY=sk-xxx bash -s -- --profile minimax

Already have a local DB-GPT checkout? Reuse it instead of cloning ~/.dbgpt/DB-GPT:

OPENAI_API_KEY=sk-xxx \
  bash scripts/install/install.sh --profile openai --repo-dir "$(pwd)" --yes

Or reuse your local repo with Kimi 2.5:

MOONSHOT_API_KEY=sk-xxx \
  bash scripts/install/install.sh --profile kimi --repo-dir "$(pwd)" --yes

Or reuse your local repo with MiniMax:

MINIMAX_API_KEY=sk-xxx \
  bash scripts/install/install.sh --profile minimax --repo-dir "$(pwd)" --yes

After installation, start the server with the generated profile config:

cd ~/.dbgpt/DB-GPT && uv run dbgpt start webserver --profile <profile>

Then open http://localhost:5670.

Prefer to review the script first?

curl -fsSL https://raw.githubusercontent.com/eosphoros-ai/DB-GPT/main/scripts/install/install.sh -o install.sh
less install.sh
bash install.sh --profile openai

Install via PyPI

Install DB-GPT from PyPI and start it with a single command — no source checkout required.

Prerequisites: Python 3.10+ and uv (recommended) or pip.

1. Install

# Recommended: use uv
uv pip install dbgpt-app

# Or with pip
pip install dbgpt-app

The default installation includes the core framework (CLI, FastAPI, Agent), OpenAI-compatible LLM support, DashScope / Tongyi support, RAG document parsing, and ChromaDB vector store.

2. Start

dbgpt start

On first run, an interactive setup wizard will guide you through choosing an LLM provider and entering your API key. Once complete, the web server starts automatically.

3. Open the Web UI

Visit http://localhost:5670 — you're all set! 🎉

Advanced Installation

Docker Linux macOS Windows

For Docker, local GPU models (vLLM, llama.cpp), or manual source-code setup, see the full docs:

Core Capabilities

Agentic Analysis

SQL + Code Execution

Multi-Source Data Access

Skills and Agents

Reporting and Decision Support

Safe Execution

Text2SQL Finetune

LLM Supported
LLaMA ✅
LLaMA-2 ✅
BLOOM ✅
BLOOMZ ✅
Falcon ✅
Baichuan ✅
Baichuan2 ✅
InternLM ✅
Qwen ✅
XVERSE ✅
ChatGLM2 ✅

More Information about Text2SQL finetune

Supported Models

Provider Supported Models
DeepSeek ✅ 🔥🔥🔥 DeepSeek-R1-0528
🔥🔥🔥 DeepSeek-V3-0324
🔥🔥🔥 DeepSeek-R1
🔥🔥🔥 DeepSeek-V3
🔥🔥🔥 DeepSeek-R1-Distill-Llama-70B
🔥🔥🔥 DeepSeek-R1-Distill-Qwen-32B
🔥🔥🔥 DeepSeek-Coder-V2-Instruct
Qwen ✅ 🔥🔥🔥 Qwen3-235B-A22B
🔥🔥🔥 Qwen3-30B-A3B
🔥🔥🔥 Qwen3-32B
🔥🔥🔥 QwQ-32B
🔥🔥🔥 Qwen2.5-Coder-32B-Instruct
🔥🔥🔥 Qwen2.5-Coder-14B-Instruct
🔥🔥🔥 Qwen2.5-72B-Instruct
🔥🔥🔥 Qwen2.5-32B-Instruct
GLM ✅ 🔥🔥🔥 GLM-Z1-32B-0414
🔥🔥🔥 GLM-4-32B-0414
🔥🔥🔥 Glm-4-9b-chat
Llama ✅ 🔥🔥🔥 Meta-Llama-3.1-405B-Instruct
🔥🔥🔥 Meta-Llama-3.1-70B-Instruct
🔥🔥🔥 Meta-Llama-3.1-8B-Instruct
🔥🔥🔥 Meta-Llama-3-70B-Instruct
🔥🔥🔥 Meta-Llama-3-8B-Instruct
Gemma ✅ 🔥🔥🔥 gemma-2-27b-it
🔥🔥🔥 gemma-2-9b-it
🔥🔥🔥 gemma-7b-it
🔥🔥🔥 gemma-2b-it
Yi ✅ 🔥🔥🔥 Yi-1.5-34B-Chat
🔥🔥🔥 Yi-1.5-9B-Chat
🔥🔥🔥 Yi-1.5-6B-Chat
🔥🔥🔥 Yi-34B-Chat
Starling ✅ 🔥🔥🔥 Starling-LM-7B-beta
SOLAR ✅ 🔥🔥🔥 SOLAR-10.7B
Mixtral ✅ 🔥🔥🔥 Mixtral-8x7B
Phi ✅ 🔥🔥🔥 Phi-3

Privacy and Security

We protect data privacy and execution safety through private model deployment, proxy desensitization, and sandboxed execution mechanisms.

Data Sources

Vision

We believe the future of data products goes beyond dashboards.

The next generation of AI + Data products will be:

DB-GPT aims to help developers and enterprises build that future.

Contribution

Contributors Wall

Licence

The MIT License (MIT)

DISCKAIMER

Citation

If you want to understand the overall architecture of DB-GPT, please cite Paper and Paper

If you want to learn about using DB-GPT for Agent development, please cite the Paper

@article{xue2023dbgpt,
      title={DB-GPT: Empowering Database Interactions with Private Large Language Models}, 
      author={Siqiao Xue and Caigao Jiang and Wenhui Shi and Fangyin Cheng and Keting Chen and Hongjun Yang and Zhiping Zhang and Jianshan He and Hongyang Zhang and Ganglin Wei and Wang Zhao and Fan Zhou and Danrui Qi and Hong Yi and Shaodong Liu and Faqiang Chen},
      year={2023},
      journal={arXiv preprint arXiv:2312.17449},
      url={https://arxiv.org/abs/2312.17449}
}
@misc{huang2024romasrolebasedmultiagentdatabase,
      title={ROMAS: A Role-Based Multi-Agent System for Database monitoring and Planning}, 
      author={Yi Huang and Fangyin Cheng and Fan Zhou and Jiahui Li and Jian Gong and Hongjun Yang and Zhidong Fan and Caigao Jiang and Siqiao Xue and Faqiang Chen},
      year={2024},
      eprint={2412.13520},
      archivePrefix={arXiv},
      primaryClass={cs.AI},
      url={https://arxiv.org/abs/2412.13520}, 
}
@inproceedings{xue2024demonstration,
      title={Demonstration of DB-GPT: Next Generation Data Interaction System Empowered by Large Language Models}, 
      author={Siqiao Xue and Danrui Qi and Caigao Jiang and Wenhui Shi and Fangyin Cheng and Keting Chen 

DB-GPT (eosphoros-ai/DB-GPT)

Searching Database…

20.2K ·GitHub
这是干什么的?一个开源的 AI 智能体数据助手:连接数据库、文件或知识库,用大白话提问,AI 会自动编写 SQL 和代码、执行分析,并生成图表、仪表盘和报告。
这是云服务,还是要我自己部署运行的?需要自己部署:它以 Python 包的形式安装,启动一个本地 Web 服务器,你通过浏览器里的 Web 界面来使用。它也可以作为平台,用来构建 AI 原生的数据应用。
怎么把它跑起来?在 macOS 和 Linux 上一行命令即可安装,或者用 Python 3.10+ 和 uv 或 pip 从 PyPI 安装。首次运行时,设置向导会让你选择 LLM 服务商并填写 API 密钥,之后 Web 服务器会自动启动。
必须有付费的 API 密钥吗,还是可以在本地跑模型?向导里提供多种服务商,比如 OpenAI 兼容 API、DashScope、Kimi 和 MiniMax。如果你想在自己的硬件上跑推理,也支持通过 vLLM 或 llama.cpp 使用本地 GPU 模型。
那个一行命令的安装器在 Windows 上也能用吗?不能——快速安装器只支持 macOS 和 Linux。Windows 用户需要参考进阶安装文档,里面还介绍了 Docker 和手动源码安装的方式。
我的数据比较敏感——它到底会被传到哪里?它就是为私有化部署设计的:隐私和执行安全依赖私有模型部署、代理脱敏和沙箱执行,你还可以搭配本地部署的模型,而不使用云端 API。
它能对接哪些数据源?关系型数据库、CSV 和 Excel 文件、文档和知识库——而且可以在同一个流程里混合使用多种数据源,比如数据库查询和表格分析可以放在同一个智能体任务里。
它支持哪些 LLM?官方列出的支持模型包括 DeepSeek、Qwen、GLM、Llama、Gemma、Yi、Starling、SOLAR、Mixtral 和 Phi;快速上手指南还提供了现成配置,比如通过 Moonshot 使用 Kimi 2.5,以及通过 OpenAI 兼容 API 使用 MiniMax。
默认从 PyPI 安装包含哪些东西?核心框架——CLI、FastAPI 服务器和 Agent——外加 OpenAI 兼容和 DashScope 的 LLM 支持、RAG 文档解析以及 ChromaDB 向量库,所以基础的 RAG 场景开箱即用。
我能把自己的分析流程打包起来复用吗?可以——领域知识、分析方法和执行步骤会打包成可复用的技能(skills),而且借助 AWEL,你还可以在这个平台之上组合出智能体、工作流和应用。
What are similar projects?h2ogpt, pandas-ai, ruflo, turnstone, DeepAnalyze, sim, vanna, apowerb
Size
498.6 MB
Stars
20.2K
Age
3y
Commits · 90 Days