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
Что это такое?Открытый ИИ-ассистент для работы с данными: подключите базы данных, файлы или базы знаний, задайте вопрос обычным языком — и ИИ напишет SQL и код, выполнит анализ и подготовит графики, дашборды и отчёты.
Это облачный сервис или что-то, что я размещаю и запускаю сам?Что-то, что вы размещаете сами: устанавливается как Python-пакет, запускает локальный веб-сервер, и вы работаете с ним через веб-интерфейс в браузере. Также это платформа для создания приложений для работы с данными с ИИ в основе.
Как его запустить?Однострочный установщик на macOS и Linux, либо установка с PyPI через Python 3.10+ и uv или pip. При первом запуске мастер настройки спросит провайдера LLM и API-ключ, после чего веб-сервер запустится автоматически.
Нужен ли платный API-ключ, или можно запускать модели локально?Мастер настройки предлагает провайдеров вроде OpenAI-совместимых API, DashScope, Kimi и MiniMax. Если хотите, чтобы обработка выполнялась на вашем железе, поддерживаются и локальные GPU-модели через vLLM или llama.cpp.
Однострочный установщик работает и на Windows?Нет — быстрый установщик поддерживает только macOS и Linux. На Windows вам придётся пройти по документации расширенной установки, где также описаны Docker и установка вручную из исходного кода.
У меня чувствительные данные — куда они на самом деле попадают?Проект рассчитан на приватное развёртывание: конфиденциальность и безопасность выполнения основаны на частном развёртывании моделей, обезличивании через прокси и запуске в изолированной среде (песочнице), а вместо облачного API можно подключить локально размещённые модели.
С какими источниками данных он умеет работать?Реляционные базы данных, файлы CSV и Excel, документы и базы знаний — причём источники можно комбинировать в одном сценарии: запрос к базе и анализ таблицы могут быть частью одной задачи с ИИ-агентом.
Какие LLM он поддерживает?В списке поддерживаемых провайдеров — DeepSeek, Qwen, GLM, Llama, Gemma, Yi, Starling, SOLAR, Mixtral и Phi, а в быстром старте есть готовые профили для Kimi 2.5 через Moonshot и MiniMax через OpenAI-совместимый API.
Что входит в базовую установку с 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
476.9 MB
Stars
20.2K
Age
3y
Commits · 90 Days