Skip to content

Commit aec6673

Browse files
authored
docs: install and readme (#2991)
1 parent ef83851 commit aec6673

File tree

8 files changed

+136
-35
lines changed

8 files changed

+136
-35
lines changed

README.hi.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -127,13 +127,30 @@ DB-GPT की वास्तुकला निम्नलिखित चि
127127
- [dbgpt-ext](./packages/dbgpt-ext)
128128
---
129129

130-
![app_chat_v0 6](https://github.com/user-attachments/assets/a2f0a875-df8c-4f0d-89a3-eed321c02113)
130+
## क्यों DB-GPT?
131131

132-
![app_manage_chat_data_v0 6](https://github.com/user-attachments/assets/c8cc85bb-e3c2-4fab-8fb9-7b4b469d0611)
132+
### 1. एजेंटिक डेटा विश्लेषण
133+
कार्यों की योजना बनाएं, कार्य को चरणों में विभाजित करें, टूल्स को कॉल करें, और विश्लेषण वर्कफ़्लो को अंत तक पूरा करें।
134+
![csv_data_analysis_demo](https://github.com/user-attachments/assets/4921fa40-20f7-4a9c-b908-c0b4e7caa9d6)
133135

134-
![chat_dashboard_display_v0 6](https://github.com/user-attachments/assets/b15d6ebe-54c4-4527-a16d-02fbbaf20dc9)
136+
### 2. स्वायत्त SQL + कोड निष्पादन
137+
डेटा को क्वेरी करने, डेटासेट साफ़ करने, मेट्रिक्स की गणना करने और आउटपुट उत्पन्न करने के लिए SQL और कोड जenerate करें।
138+
![agentic_write_code](https://github.com/user-attachments/assets/aeebc2b8-6c50-4ebb-96fd-07b860faa044)
139+
![sql_query](https://github.com/user-attachments/assets/da45de20-3768-4f0d-ab20-e939ddf21361)
135140

136-
![agent_prompt_awel_v0 6](https://github.com/user-attachments/assets/40761507-a1e1-49d4-b49a-3dd9a5ea41cc)
141+
### 3. मल्टी-सोर्स डेटा एक्सेस
142+
संरचित और असंरचित स्रोतों के साथ काम करें, जिसमें डेटाबेस, स्प्रेडशीट, दस्तावेज़ और नॉलेज बेस शामिल हैं।
143+
144+
### 4. स्किल्स-संचालित एक्स्टेंसिबिलिटी
145+
डोमेन ज्ञान, विश्लेषण विधियों और निष्पादन वर्कफ़्लो को पुन: प्रयोज्य स्किल्स में पैकेज करें।
146+
147+
![import_github_skill](https://github.com/user-attachments/assets/39f39c36-a014-4a2e-8e14-b3af3f1d2f1c)
148+
149+
![agent_browse_use](https://github.com/user-attachments/assets/21864e9f-2179-4f6f-910f-18463ec2b46e)
150+
151+
### 5. सैंडबॉक्स्ड निष्पादन
152+
सुरक्षित, अधिक विश्वसनीय विश्लेषण के लिए अलग-थलग वातावरण में कोड और टूल्स चलाएं।
153+
![sandbox](https://github.com/user-attachments/assets/bfbd78e0-15e2-42ac-876f-5b91847aadc1)
137154

138155

139156
## इंस्टॉलेशन / क्विक स्टार्ट

README.ja.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -130,13 +130,30 @@ DB-GPTのアーキテクチャは以下の図に示されています:
130130

131131
---
132132

133-
![app_chat_v0 6](https://github.com/user-attachments/assets/a2f0a875-df8c-4f0d-89a3-eed321c02113)
133+
## なぜDB-GPTなのか?
134134

135-
![app_manage_chat_data_v0 6](https://github.com/user-attachments/assets/c8cc85bb-e3c2-4fab-8fb9-7b4b469d0611)
135+
### 1. エージェント型データ分析
136+
タスクを計画し、作業をステップに分解し、ツールを呼び出して、分析ワークフローをエンドツーエンドで完了します。
137+
![csv_data_analysis_demo](https://github.com/user-attachments/assets/4921fa40-20f7-4a9c-b908-c0b4e7caa9d6)
136138

137-
![chat_dashboard_display_v0 6](https://github.com/user-attachments/assets/b15d6ebe-54c4-4527-a16d-02fbbaf20dc9)
139+
### 2. 自律型SQL + コード実行
140+
SQLとコードを生成してデータをクエリし、データセットをクリーン化し、メトリクスを計算し、出力を生成します。
141+
![agentic_write_code](https://github.com/user-attachments/assets/aeebc2b8-6c50-4ebb-96fd-07b860faa044)
142+
![sql_query](https://github.com/user-attachments/assets/da45de20-3768-4f0d-ab20-e939ddf21361)
138143

139-
![agent_prompt_awel_v0 6](https://github.com/user-attachments/assets/40761507-a1e1-49d4-b49a-3dd9a5ea41cc)
144+
### 3. マルチソースデータアクセス
145+
構造化データと非構造化データの両方で動作し、データベース、スプレッドシート、ドキュメント、ナレッジベースが含まれます。
146+
147+
### 4. スキル駆動の拡張性
148+
ドメイン知識、分析方法、実行ワークフローを再利用可能なスキルとしてパッケージ化します。
149+
150+
![import_github_skill](https://github.com/user-attachments/assets/39f39c36-a014-4a2e-8e14-b3af3f1d2f1c)
151+
152+
![agent_browse_use](https://github.com/user-attachments/assets/21864e9f-2179-4f6f-910f-18463ec2b46e)
153+
154+
### 5. サンドボックス実行
155+
分離された環境でコードとツールを実行して、より安全で可靠性の高い分析を実現します。
156+
![sandbox](https://github.com/user-attachments/assets/bfbd78e0-15e2-42ac-876f-5b91847aadc1)
140157

141158

142159
## インストール

README.ma.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,13 +128,30 @@ DB-GPT-യുടെ ആർക്കിടെക്ചർ ഇനിപ്പറ
128128
- [dbgpt-ext](./packages/dbgpt-ext)
129129
---
130130

131-
![app_chat_v0 6](https://github.com/user-attachments/assets/a2f0a875-df8c-4f0d-89a3-eed321c02113)
131+
## എന്തിനാണ് DB-GPT?
132132

133-
![app_manage_chat_data_v0 6](https://github.com/user-attachments/assets/c8cc85bb-e3c2-4fab-8fb9-7b4b469d0611)
133+
### 1. ഏജന്റ് അധിഷ്ഠിത ഡാറ്റാ അനലിസിസ്
134+
ടാസ്ക്കുകൾ പ്ലാൻ ചെയ്യുക, വര്ക്ക് സ്റ്റെപ്പുകളായി വിഭജിക്കുക, ടൂളുകൾ വിളിക്കുക, അനലിസിസ് വർക്ക്ഫ്ലോകൾ അവസാനിപ്പിക്കുക.
135+
![csv_data_analysis_demo](https://github.com/user-attachments/assets/4921fa40-20f7-4a9c-b908-c0b4e7caa9d6)
134136

135-
![chat_dashboard_display_v0 6](https://github.com/user-attachments/assets/b15d6ebe-54c4-4527-a16d-02fbbaf20dc9)
137+
### 2. സ്വയംപ്രവര്ത്തിക്കുന്ന SQL + കോഡ് എക്സിക്യൂഷന്‍
138+
ഡാറ്റ ചോദിക്കാനും ഡാറ്റാസെറ്റുകൾ വൃത്തിയാക്കാനും മെട്രിക്കുകൾ കണക്കാക്കാനും ഔട്ട്പുട്ട്കൾ ഉത്പാദിപ്പിക്കാനും SQLഉം കോഡും സൃഷ്ടിക്കുക.
139+
![agentic_write_code](https://github.com/user-attachments/assets/aeebc2b8-6c50-4ebb-96fd-07b860faa044)
140+
![sql_query](https://github.com/user-attachments/assets/da45de20-3768-4f0d-ab20-e939ddf21361)
136141

137-
![agent_prompt_awel_v0 6](https://github.com/user-attachments/assets/40761507-a1e1-49d4-b49a-3dd9a5ea41cc)
142+
### 3. മൾട്ടി-സോഴ്സ് ഡാറ്റ ആക്സസ്
143+
സ്ട്രക്ചേഡും അൺസ്ട്രക്ചേഡുമായ സോഴ്സുകളിലൂടെ പ്രവർത്തിക്കുക, ഡാറ്റാബേസുകൾ, സ്പ്രഡ്ഷീറ്റുകൾ, ഡോക്യുമെന്റുകളും നോളജ് ബേസുകളും ഉൾപ്പെടുന്നു.
144+
145+
### 4. സ്കില്ല്-ഡ്രിവന്‍ എക്സ്റ്റെംസിബിലിറ്റി
146+
ഡൊമെയ്‌ന്‍ അറിവ്, അനലിസിസ് രീതികളും എക്സിക്യൂഷന്‍ വർക്ക്ഫ്ലോകളും പുനരുപയോഗിക്കാവുന്ന സ്കില്ലുകളായി പാക്കേജ് ചെയ്യുക.
147+
148+
![import_github_skill](https://github.com/user-attachments/assets/39f39c36-a014-4a2e-8e14-b3af3f1d2f1c)
149+
150+
![agent_browse_use](https://github.com/user-attachments/assets/21864e9f-2179-4f6f-910f-18463ec2b46e)
151+
152+
### 5. സാന്ഡ്ബോക്സ് എക്സിക്യൂഷന്‍
153+
കൂടുതൽ സുരക്ഷിതവും കൂടുതൽ വിശ്വസനീയവുമായ അനലിസിസിനായി ഐസോലേറ്റഡ് എൻവയോണ്മെന്റിൽ കോഡും ടൂളുകളും റൺ ചെയ്യുക.
154+
![sandbox](https://github.com/user-attachments/assets/bfbd78e0-15e2-42ac-876f-5b91847aadc1)
138155

139156

140157
## ഇൻസ്റ്റലേഷൻ / ക്വിക്ക് സ്റ്റാർട്ട്

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@
5252

5353
> **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.**
5454
55+
![welcome_page](https://github.com/user-attachments/assets/ff9beb32-7db5-487a-bd81-d4489d853ea5)
56+
5557
## What is DB-GPT?
5658

5759
DB-GPT is an open-source **agentic AI data assistant** for the next generation of **AI + Data** products.
@@ -70,18 +72,31 @@ DB-GPT is also a platform for building **AI-native data agents, workflows, and a
7072

7173
### 1. Agentic data analysis
7274
Plan tasks, break work into steps, call tools, and complete analysis workflows end to end.
75+
![csv_data_analysis_demo_en](https://github.com/user-attachments/assets/4921fa40-20f7-4a9c-b908-c0b4e7caa9d6)
7376

7477
### 2. Autonomous SQL + code execution
7578
Generate SQL and code to query data, clean datasets, compute metrics, and produce outputs.
79+
![agentic_write_code](https://github.com/user-attachments/assets/aeebc2b8-6c50-4ebb-96fd-07b860faa044)
80+
![sql_query](https://github.com/user-attachments/assets/da45de20-3768-4f0d-ab20-e939ddf21361)
7681

7782
### 3. Multi-source data access
7883
Work across structured and unstructured sources, including databases, spreadsheets, documents, and knowledge bases.
7984

8085
### 4. Skills-driven extensibility
8186
Package domain knowledge, analysis methods, and execution workflows into reusable skills.
8287

88+
89+
90+
91+
92+
![import_github_skill](https://github.com/user-attachments/assets/39f39c36-a014-4a2e-8e14-b3af3f1d2f1c)
93+
94+
![agent_browse_use](https://github.com/user-attachments/assets/21864e9f-2179-4f6f-910f-18463ec2b46e)
8395
### 5. Sandboxed execution
8496
Run code and tools in isolated environments for safer, more reliable analysis.
97+
![sandbox](https://github.com/user-attachments/assets/bfbd78e0-15e2-42ac-876f-5b91847aadc1)
98+
99+
85100

86101
## What you can do with DB-GPT
87102

@@ -107,14 +122,6 @@ Load reusable skills for repeatable business analysis workflows.
107122
### Generate reports
108123
Produce charts, dashboards, HTML reports, and decision-ready outputs.
109124

110-
![app_chat_v0 6](https://github.com/user-attachments/assets/a2f0a875-df8c-4f0d-89a3-eed321c02113)
111-
112-
![app_manage_chat_data_v0 6](https://github.com/user-attachments/assets/c8cc85bb-e3c2-4fab-8fb9-7b4b469d0611)
113-
114-
![chat_dashboard_display_v0 6](https://github.com/user-attachments/assets/b15d6ebe-54c4-4527-a16d-02fbbaf20dc9)
115-
116-
![agent_prompt_awel_v0 6](https://github.com/user-attachments/assets/40761507-a1e1-49d4-b49a-3dd9a5ea41cc)
117-
118125

119126
## Quick Start
120127

@@ -280,7 +287,8 @@ DB-GPT is also a platform for building AI-native data systems.
280287
[More Information about Text2SQL finetune](https://github.com/eosphoros-ai/DB-GPT-Hub)
281288
282289
### Supported Models
283-
<table>
290+
291+
<table>
284292
<thead>
285293
<tr>
286294
<th>Provider</th>

README.ta.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -127,12 +127,32 @@ DB-GPT இன் கட்டமைப்பு பின்வரும் ப
127127
---
128128

129129
![app_chat_v0 6](https://github.com/user-attachments/assets/a2f0a875-df8c-4f0d-89a3-eed321c02113)
130+
---
131+
132+
## ஏன் DB-GPT?
133+
134+
### 1. முகவர் அடிப்படையான தரவு பகுப்பாய்வு
135+
பணிகளைத் திட்டமிடுங்கள், வேலையைப் படிகளாகப் பிரிங்கள், கருவிகளை அழைக்கவும், முழுமையான பகுப்பாய்வு பணிப்பாய்வுகளை முடிக்கவும்.
136+
![csv_data_analysis_demo](https://github.com/user-attachments/assets/4921fa40-20f7-4a9c-b908-c0b4e7caa9d6)
137+
138+
### 2. தானியங்கி SQL + குறியீடு செயல்படுத்தல்
139+
தரவைக் கேட்க, தரவுத் தொகுப்புகளை சுத்தம் செய்ய, மெட்ரிக்கைக் கணக்கிட்டு, வெளியீடுகளை உருவாக்க SQL மற்றும் குறியீட்டை உருவாக்குங்கள்.
140+
![agentic_write_code](https://github.com/user-attachments/assets/aeebc2b8-6c50-4ebb-96fd-07b860faa044)
141+
![sql_query](https://github.com/user-attachments/assets/da45de20-3768-4f0d-ab20-e939ddf21361)
142+
143+
### 3. பல-மூல தரவு அணுகல்
144+
கட்டமைக்கப்பட்ட மற்றும் கட்டமைக்கப்படாத மூலங்கள் உட்பட, தரவுத்தளங்கள், spreadsheetகள், ஆவணங்கள் மற்றும் அறிவு தளங்கள் முழுவதும் வேலை செய்யுங்கள்.
145+
146+
### 4. திறன்கள்-இயக்கப்படும் நீட்சி
147+
துறை அறிவு, பகுப்பாய்வு முறைகள் மற்றும் செயல்படுத்தும் பணிப்பாய்வுகளை மீண்டும் பயன்படுத்தக்கூடிய திறன்களாகத் தொகுக்கவும்.
130148

131-
![app_manage_chat_data_v0 6](https://github.com/user-attachments/assets/c8cc85bb-e3c2-4fab-8fb9-7b4b469d0611)
149+
![import_github_skill](https://github.com/user-attachments/assets/39f39c36-a014-4a2e-8e14-b3af3f1d2f1c)
132150

133-
![chat_dashboard_display_v0 6](https://github.com/user-attachments/assets/b15d6ebe-54c4-4527-a16d-02fbbaf20dc9)
151+
![agent_browse_use](https://github.com/user-attachments/assets/21864e9f-2179-4f6f-910f-18463ec2b46e)
134152

135-
![agent_prompt_awel_v0 6](https://github.com/user-attachments/assets/40761507-a1e1-49d4-b49a-3dd9a5ea41cc)
153+
### 5. சாண்ட்பாக்ஸ் செயல்படுத்தல்
154+
பாதுகாப்பான, மிகவும் நம்பகமான பகுப்பாய்வுக்காகத் தனிமைப்படுத்தப்பட்ட சூழலில் குறியீடு மற்றும் கருவிகளை இயக்குங்கள்.
155+
![sandbox](https://github.com/user-attachments/assets/bfbd78e0-15e2-42ac-876f-5b91847aadc1)
136156

137157

138158
## Installation / Quick Start

README.zh.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -70,18 +70,26 @@ DB-GPT 不只是一个助手界面,它同时也是一个平台,用于构建
7070

7171
### 1. Agentic 数据分析
7272
它不只是回答问题,而是会进行任务规划、步骤拆解、工具调用和迭代式分析。
73+
![csv-data-analysis_skill](https://github.com/user-attachments/assets/de0073f6-6b69-42f1-9fd2-5b759ca88ed8)
7374

7475
### 2. 自主 SQL + 自主代码执行
7576
自动编写 SQL 和代码,用于查询数据、处理数据、计算指标并生成结果。
77+
![agentic_write_code](https://github.com/user-attachments/assets/aeebc2b8-6c50-4ebb-96fd-07b860faa044)
78+
![sql_query](https://github.com/user-attachments/assets/da45de20-3768-4f0d-ab20-e939ddf21361)
7679

7780
### 3. 多数据源分析
7881
同时处理结构化与非结构化数据,包括数据库、表格文件、文档和知识库。
7982

8083
### 4. Skills 驱动的可扩展能力
8184
将领域知识、分析方法和执行流程沉淀为 skills,实现复用与扩展。
8285

86+
![import_github_skill](https://github.com/user-attachments/assets/39f39c36-a014-4a2e-8e14-b3af3f1d2f1c)
87+
88+
![agent_browse_use](https://github.com/user-attachments/assets/21864e9f-2179-4f6f-910f-18463ec2b46e)
89+
8390
### 5. 沙箱安全执行
8491
在隔离环境中运行代码和工具,让分析过程更安全、更可控。
92+
![sandbox](https://github.com/user-attachments/assets/bfbd78e0-15e2-42ac-876f-5b91847aadc1)
8593

8694
## 你可以用 DB-GPT 做什么?
8795

@@ -107,14 +115,6 @@ DB-GPT 不只是一个助手界面,它同时也是一个平台,用于构建
107115
### 生成报告
108116
自动输出图表、Dashboard、HTML 报告和决策结论。
109117

110-
![app_chat_v0 6](https://github.com/user-attachments/assets/a2f0a875-df8c-4f0d-89a3-eed321c02113)
111-
112-
![app_manage_chat_data_v0 6](https://github.com/user-attachments/assets/c8cc85bb-e3c2-4fab-8fb9-7b4b469d0611)
113-
114-
![chat_dashboard_display_v0 6](https://github.com/user-attachments/assets/b15d6ebe-54c4-4527-a16d-02fbbaf20dc9)
115-
116-
![agent_prompt_awel_v0 6](https://github.com/user-attachments/assets/40761507-a1e1-49d4-b49a-3dd9a5ea41cc)
117-
118118

119119
## 快速开始
120120

@@ -285,7 +285,8 @@ DB-GPT 同时也是一个构建 AI Native 数据产品的平台,提供:
285285
| ChatGLM2 ||
286286
287287
### 支持模型
288-
<table>
288+
289+
<table>
289290
<thead>
290291
<tr>
291292
<th>Provider</th>

scripts/install/install.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ step_choose_profile() {
218218
printf '\n'
219219

220220
local choice
221-
read -r -p "Enter choice [1]: " choice
221+
prompt_input "Enter choice [1]: " choice
222222
choice="${choice:-1}"
223223

224224
case "${choice}" in

scripts/install/lib/common.sh

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,27 @@ success() {
2727
printf "${COLOR_GREEN}[OK]${COLOR_RESET} %s\n" "$*"
2828
}
2929

30+
prompt_input() {
31+
local prompt="$1"
32+
local __resultvar="$2"
33+
local answer=""
34+
35+
if [[ -r /dev/tty ]]; then
36+
if read -r -p "${prompt}" answer < /dev/tty 2>/dev/null; then
37+
printf -v "${__resultvar}" '%s' "${answer}"
38+
return
39+
fi
40+
fi
41+
42+
if [[ -t 0 ]]; then
43+
read -r -p "${prompt}" answer || die "Failed to read input from stdin."
44+
else
45+
die "Interactive input requires a terminal. Re-run with explicit flags such as --profile <name> or --yes."
46+
fi
47+
48+
printf -v "${__resultvar}" '%s' "${answer}"
49+
}
50+
3051
die() {
3152
error "$*"
3253
exit 1
@@ -63,7 +84,7 @@ confirm() {
6384
fi
6485

6586
local answer
66-
read -r -p "${prompt} [y/N]: " answer
87+
prompt_input "${prompt} [y/N]: " answer
6788
[[ "${answer}" =~ ^[Yy]$ ]]
6889
}
6990

0 commit comments

Comments
 (0)