CLI Quick Start
Install DB-GPT from PyPI and start it with a single command â no source checkout required.
- Python 3.10 or later
- uv package manager (recommended) or pip
1. Installâ
# Recommended: use uv
uv pip install dbgpt-app
# Or with pip
pip install dbgpt-app
For faster downloads, specify a mirror when installing:
uv pip install dbgpt-app --index-url https://pypi.tuna.tsinghua.edu.cn/simple # uv
pip install dbgpt-app -i https://pypi.tuna.tsinghua.edu.cn/simple # pip
Alternatively, set an environment variable to apply the mirror to all installs in the current shell session:
export UV_INDEX_URL=https://pypi.tuna.tsinghua.edu.cn/simple # uv
export PIP_INDEX_URL=https://pypi.tuna.tsinghua.edu.cn/simple # pip
The default installation includes the core framework (CLI, FastAPI, SQLAlchemy, Agent), OpenAI-compatible LLM support (also works with Kimi, Qwen, MiniMax, Z.AI), DashScope / Tongyi support, RAG document parsing, and ChromaDB vector store.
Need additional providers or data sources? See Optional Modules.
After installation the dbgpt command is available in your terminal.
2. Start DB-GPTâ
dbgpt start
That's it! On first run DB-GPT will launch an interactive setup wizard that helps you:
- Choose an LLM provider (OpenAI, Kimi, Qwen, MiniMax, Z.AI, or a custom endpoint)
- Enter your API key (or use an environment variable)
- Confirm the model names and API base URL
Once complete, a TOML configuration file is written to ~/.dbgpt/configs/<profile>.toml and the web server starts automatically.
What the startup looks likeâ
____ ____ ____ ____ _____
| _ \| __ ) / ___| _ \_ _|
| | | | _ \ ____| | _| |_) || |
| |_| | |_) |____| |_| | __/ | |
|____/|____/ \____|_| |_|
đ DB-GPT Quick Start
+- - - - - - - - - - - - - - - - - - - - - - - -+
: Profile: openai :
: Config: /Users/you/.dbgpt/configs/openai.toml:
: Workspace: /Users/you/.dbgpt/workspace :
+- - - - - - - - - - - - - - - - - - - - - - - -+