DB-GPT dbgpts 生态组件完全指南可复用市场、CLI 命令与自定义包开发实战【免费下载链接】DB-GPTopen-source agentic AI data assistant for the next generation of AI Data products.项目地址: https://gitcode.com/GitHub_Trending/db/DB-GPTdbgpts是 DB-GPT 官方的可复用组件社区仓库集中托管 apps完整应用、operatorsAWEL 算子、workflow templates工作流模板与 agents智能体定义。本篇指南将以 getting-started/tools/dbgpts.md 为核心骨架结合本仓库内 CLI 实现与加载器源码系统讲解 dbgpts 的组件类型、安装方式、全套命令用法、Web UI 集成方式以及从零创建并发布自定义 dbgpts 包的完整流程。读完本文你将能够熟练安装/卸载/更新组件、管理自定义仓库repo并写出符合规范、可被 DB-GPT 自动加载的 dbgpts 包。什么是 dbgpts 生态dbgpts 是 DB-GPT 的可复用组件官方社区仓库它为 DB-GPT 提供了即装即用的扩展能力。与需要从零编码不同这些组件被设计为可以直接被 DB-GPT 的 CLI 或 Web UI 消费的标准化单元。官方将组件划分为四种核心类型组件类型说明典型示例Apps可直接安装使用的完整应用数据分析应用、报表生成器Operators用于工作流的 AWEL 算子文本切分器、HTTP 请求、LLM 调用Workflow Templates预构建的 AWEL 工作流 DAGRAG 流水线、多智能体对话Agents预配置的智能体定义SQL 分析师、代码审查员从本仓库源码来看这一分类体系比文档描述得更为细致。在 base.py 中DEFAULT_PACKAGES定义了仓库内实际的目录组织为[agents, apps, operators, workflow, resources]对应的包类型DEFAULT_PACKAGE_TYPES为[agent, app, operator, flow, resource]。这意味着除了文档表格中的四类外源码中还支持resource资源/工具类型——它用于打包诸如函数工具tool装饰的函数和 Agent 资源等能力。类型与目录的映射关系由TYPE_TO_PACKAGE明确定义TYPE_TO_PACKAGE { agent: agents, app: apps, operator: operators, flow: workflow, resource: resources, }安装 dbgpts CLIdbgptsCLI 是随 DB-GPT 一并安装的命令行工具。安装时只需启用dbgptsextrauv sync --all-packages --extra dbgpts ...该 extra 在 dbgpt-app/pyproject.toml 中定义为dbgpts [ # For build dbgpts apps, we will be removed in the future. build, poetry ]也就是说该 extra 会额外引入build与poetry两个构建工具。这是因为 dbgpts 包的安装机制需要先构建 wheel 再安装详见下文安装的底层原理一节。另外从 cli.py 的check_build_tools_installed()逻辑可以看出CLI 在安装前会检测uv、poetry、build、setuptools四类构建工具uv为首选推荐若完全没有任何构建工具会直接报错退出若缺少uv仅给出警告提示建议pip install uv不会中断安装。因此保持环境中至少有一个可用的构建工具是顺利安装组件的前提。CLI 命令全解析dbgpts命令通过 cli_scripts.py 集成到dbgpt主命令下注册为dbgpt app、dbgpt repo、dbgpt new app等子命令组。日常使用中你既可以直接调用dbgpts也可以使用dbgpt app/dbgpt repo等别名。浏览可用组件# 列出远端仓库中所有可安装组件 dbgpts list-remote # 列出本地已安装的组件 dbgpts listlist-remote背后对应 repo.py 中的list_repo_apps()它遍历所有已配置的 repo扫描agents/、apps/、operators/、workflow/、resources/五个目录下包含dbgpts.toml元数据文件的包并以表格形式输出Repository / Type / Name三列。其中Type列展示的是agents、apps等目录名。默认情况下该命令会先执行一次git pull同步远端仓库保证列表是最新的。list则对应list_installed_apps()它读取安装目录并输出Name / Type / Repository / Path四列Type为agent、app、operator、flow、resource中的一种。小提示list-remote与list均支持-r/--repo repo指定单一仓库、-U/--update控制是否在列出前更新仓库。安装组件dbgpts install package-nameinstall支持一次传入多个包名nargs-1并支持以下选项# 从指定仓库安装且安装前不更新仓库 dbgpts install package-name -r repo --update false # 一次性安装多个组件 dbgpts install package-a package-b-r/--repo指定从哪个仓库安装默认在全部仓库中查找-U/--update布尔开关是否在安装前更新仓库。安装流程对应 repo.py 的install()→copy_and_install()大致为check_with_retry()在所有仓库的五个类型目录下查找该名称且带dbgpts.toml的包找不到则报错将包目录整体复制到安装目录~/.dbgpts/packages/env_sig/name检测是否为 poetry 工程依据pyproject.toml的build-system与[tool.poetry]选择构建工具构建 wheel 包依次尝试uv pip install→pip install→ 手动解压 wheel 到 site-packages写入install_metadata.toml记录包名与来源仓库完成安装。更新组件dbgpts update package-name需要说明的是update命令在 CLI 层实际对应 cli.py 中的update_repo——它面向的是**仓库repo**而非单个包不带参数时更新所有仓库-r repo指定更新某一个仓库repo all也会触发全量更新。其实现为对每个仓库目录执行git pull见 repo.py 的update_repo()。因此在日常实践中更新某个组件的推荐路径是先dbgpts update同步仓库元数据再dbgpts reinstall package-name重新安装该组件以获取最新版本。卸载组件dbgpts uninstall package-name卸载流程uninstall()若组件未安装会直接报错否则在安装目录下执行pip uninstall name -y清理 Python 包随后删除安装目录。重装组件dbgpts reinstall package-namereinstall()的语义是uninstallinstall的组合同样支持-r/--repo与-U/--update选项适合在组件升级后刷新本地版本。仓库repo管理除了包本身CLI 还提供了完整的仓库管理能力同样注册在dbgpt repo下# 列出所有已配置的仓库 dbgpts list # 添加一个新仓库git 地址或本地目录 dbgpts add --url git-or-local-path [-r repo-name] [-b branch] # 更新仓库不带参数更新全部-r 指定单个 dbgpts update [-r repo] # 移除仓库 dbgpts remove repo-name对应源码中的add_repo()仓库名必须形如group/name如eosphoros/dbgptsURL 以http或git开头时执行git clone若是本地目录则创建软链接。当没有任何仓库时安装/列出命令会自动拉取默认仓库eosphoros/dbgpts见_install_default_repos_if_no_repos()与 base.py 中的DEFAULT_REPO_MAP。使用模板新建组件dbgpts app -n name [-l label] [-d description] [-t type] [--definition_type json|python] [-C directory]对应dbgpt new app别名其中-n/--name必填组件名称-l/--label展示名称默认由 name 自动生成-、_替换为空格后转标题格式-d/--description描述默认空-t/--type类型取自click.Choice(DEFAULT_PACKAGE_TYPES)即agent / app / operator / flow / resource默认flow--definition_type定义方式json或python默认json注意除flow外其余类型强制为python-C/--directory工作目录默认当前目录。在 Web UI 中使用 dbgpts组件安装完成后DB-GPT Web 端会自动发现并展示它们Apps出现在应用商店App Store中Operators出现在 AWEL Flow 编辑器的算子面板中Workflow templates可导入 Flow 编辑器Agents可在创建多智能体应用时被选用。Web 端的实现位于 web/pages/construct/dbgpts/index.tsx该页面通过postDbgptsHubUpdate、postDbgptsQuery、postDbgptsInstall、postDbgptsMy、postDbgptsUninstall等 API 与后端交互提供市场market与我的my两个视图支持搜索、按类型过滤、安装/卸载操作。后端则由 dbgpts/hub/service/service.py 提供服务其refresh_hub_from_git()复用list_dbgpts()扫描仓库中的组件并入库。这套安装即自动出现在 Web UI的机制核心依赖运行时的加载器DBGPTsLoader见 loader.py。它是一个系统组件name dbgpt_dbgpts_loader在应用启动前加载一次已安装的包之后默认每 10 秒load_dbgpts_interval10重新扫描安装目录并自动完成以下注册agent包将包内继承ConversableAgent的类注册到agent_managerresource包将函数工具与Resource实例/类注册到resource_managerflow包转换为FlowPanel供 Flow 编辑器以只读、可导入的方式展示editable: False由_flow_package_to_flow_panel()实现。仓库目录结构dbgpts 社区仓库按组件类型组织目录dbgpts/ ├── apps/ # 完整应用 ├── operators/ # AWEL 算子 ├── workflow/ # 工作流模板 └── agents/ # 智能体定义结合本仓库源码实际约定比这更完整——包含resources目录打包函数工具与 Agent 资源并且每个包目录下必须存在dbgpts.toml元数据文件才会被 CLI 扫描与识别见 repo.py 的check_with_retry()/list_repo_apps()。包的元数据文件dbgpts.toml结构对应 loader.py 的parse_package_metadata()如下[flow] # 或 [agent] / [operator] / [resource] label My Flow name my_flow version 0.1.0 description A example flow authors [] definition_type json # 或 python [json_config] file_path definition/flow_definition.json # definition_typejson 时必填其中name、label、package_type、version、description、path、root、repo、package是 BasePackage 的核心字段安装目录下还会生成install_metadata.toml记录name与来源repo它是判断一个目录是否为已安装包的关键标志。创建自己的 dbgpts 包推荐使用模板命令快速生成符合规范的包骨架# 生成一个 flow 类型的包JSON 定义 dbgpts app -n my_flow -l My Flow -d A example flow -t flow --definition_type json # 生成一个 operator 类型的包Python 定义 dbgpts app -n hello_operator -t operator命令生成的骨架由 template.py 的create_template()完成会按TYPE_TO_PACKAGE的映射在工作目录下创建workflow/、operators/、agents/、resources/等子目录并使用uv init其次 poetry、最后手工创建初始化 Python 工程同时产出dbgpts.toml组件元数据上述示例即来自此处MANIFEST.in包含dbgpts.toml与*/definition/*.json确保构建时元数据被打包类型对应的__init__.py模板代码。以 operator 为例模板会生成一个带 AWELViewMetadata元数据的HelloWorldOperator(MapOperator[str, str])以 agent 为例会生成继承ConversableAgent的HelloWorldSpeakerAgent与配套Action。这些模板代码可直接运行是学习自定义组件写法的最佳起点。若选择纯手工创建一个 flowJSON 定义包的最小结构为my_flow/ ├── dbgpts.toml # 元数据[flow] 段 json_config.file_path ├── pyproject.toml # 构建配置setuptools/poetry 均可 ├── MANIFEST.in # 打包包含 dbgpts.toml 与定义文件 └── my_flow/ ├── __init__.py └── definition/ └── flow_definition.json # AWEL 流程图 JSON节点/边/视图随后将包提交到 dbgpts 社区仓库即可共享请遵循仓库目录约定放置包、确保包含元数据文件dbgpts.toml并提交 Pull Request。安装方的加载链路会自动完成剩余工作——DBGPTsLoader每 10 秒扫描安装目录将 JSON 定义的 flow 解析为可导入编辑器的FlowPanel将 Python 定义的 flow 直接加载为DAG对象将 agent/operator/resource 注册到对应管理器。延伸阅读构建 AWEL 工作流AWEL FlowMCP 工具集成MCP Protocol深入理解 dbgpts 加载器与包模型loader.py、repo.py、template.py安装流程的测试验证test_dbgpts_repo.py覆盖构建失败即中止安装wheel 安装失败不落盘元数据等关键行为【免费下载链接】DB-GPTopen-source agentic AI data assistant for the next generation of AI Data products.项目地址: https://gitcode.com/GitHub_Trending/db/DB-GPT创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
DB-GPT dbgpts 生态组件完全指南：可复用市场、CLI 命令与自定义包开发实战
DB-GPT dbgpts 生态组件完全指南可复用市场、CLI 命令与自定义包开发实战【免费下载链接】DB-GPTopen-source agentic AI data assistant for the next generation of AI Data products.项目地址: https://gitcode.com/GitHub_Trending/db/DB-GPTdbgpts是 DB-GPT 官方的可复用组件社区仓库集中托管 apps完整应用、operatorsAWEL 算子、workflow templates工作流模板与 agents智能体定义。本篇指南将以 getting-started/tools/dbgpts.md 为核心骨架结合本仓库内 CLI 实现与加载器源码系统讲解 dbgpts 的组件类型、安装方式、全套命令用法、Web UI 集成方式以及从零创建并发布自定义 dbgpts 包的完整流程。读完本文你将能够熟练安装/卸载/更新组件、管理自定义仓库repo并写出符合规范、可被 DB-GPT 自动加载的 dbgpts 包。什么是 dbgpts 生态dbgpts 是 DB-GPT 的可复用组件官方社区仓库它为 DB-GPT 提供了即装即用的扩展能力。与需要从零编码不同这些组件被设计为可以直接被 DB-GPT 的 CLI 或 Web UI 消费的标准化单元。官方将组件划分为四种核心类型组件类型说明典型示例Apps可直接安装使用的完整应用数据分析应用、报表生成器Operators用于工作流的 AWEL 算子文本切分器、HTTP 请求、LLM 调用Workflow Templates预构建的 AWEL 工作流 DAGRAG 流水线、多智能体对话Agents预配置的智能体定义SQL 分析师、代码审查员从本仓库源码来看这一分类体系比文档描述得更为细致。在 base.py 中DEFAULT_PACKAGES定义了仓库内实际的目录组织为[agents, apps, operators, workflow, resources]对应的包类型DEFAULT_PACKAGE_TYPES为[agent, app, operator, flow, resource]。这意味着除了文档表格中的四类外源码中还支持resource资源/工具类型——它用于打包诸如函数工具tool装饰的函数和 Agent 资源等能力。类型与目录的映射关系由TYPE_TO_PACKAGE明确定义TYPE_TO_PACKAGE { agent: agents, app: apps, operator: operators, flow: workflow, resource: resources, }安装 dbgpts CLIdbgptsCLI 是随 DB-GPT 一并安装的命令行工具。安装时只需启用dbgptsextrauv sync --all-packages --extra dbgpts ...该 extra 在 dbgpt-app/pyproject.toml 中定义为dbgpts [ # For build dbgpts apps, we will be removed in the future. build, poetry ]也就是说该 extra 会额外引入build与poetry两个构建工具。这是因为 dbgpts 包的安装机制需要先构建 wheel 再安装详见下文安装的底层原理一节。另外从 cli.py 的check_build_tools_installed()逻辑可以看出CLI 在安装前会检测uv、poetry、build、setuptools四类构建工具uv为首选推荐若完全没有任何构建工具会直接报错退出若缺少uv仅给出警告提示建议pip install uv不会中断安装。因此保持环境中至少有一个可用的构建工具是顺利安装组件的前提。CLI 命令全解析dbgpts命令通过 cli_scripts.py 集成到dbgpt主命令下注册为dbgpt app、dbgpt repo、dbgpt new app等子命令组。日常使用中你既可以直接调用dbgpts也可以使用dbgpt app/dbgpt repo等别名。浏览可用组件# 列出远端仓库中所有可安装组件 dbgpts list-remote # 列出本地已安装的组件 dbgpts listlist-remote背后对应 repo.py 中的list_repo_apps()它遍历所有已配置的 repo扫描agents/、apps/、operators/、workflow/、resources/五个目录下包含dbgpts.toml元数据文件的包并以表格形式输出Repository / Type / Name三列。其中Type列展示的是agents、apps等目录名。默认情况下该命令会先执行一次git pull同步远端仓库保证列表是最新的。list则对应list_installed_apps()它读取安装目录并输出Name / Type / Repository / Path四列Type为agent、app、operator、flow、resource中的一种。小提示list-remote与list均支持-r/--repo repo指定单一仓库、-U/--update控制是否在列出前更新仓库。安装组件dbgpts install package-nameinstall支持一次传入多个包名nargs-1并支持以下选项# 从指定仓库安装且安装前不更新仓库 dbgpts install package-name -r repo --update false # 一次性安装多个组件 dbgpts install package-a package-b-r/--repo指定从哪个仓库安装默认在全部仓库中查找-U/--update布尔开关是否在安装前更新仓库。安装流程对应 repo.py 的install()→copy_and_install()大致为check_with_retry()在所有仓库的五个类型目录下查找该名称且带dbgpts.toml的包找不到则报错将包目录整体复制到安装目录~/.dbgpts/packages/env_sig/name检测是否为 poetry 工程依据pyproject.toml的build-system与[tool.poetry]选择构建工具构建 wheel 包依次尝试uv pip install→pip install→ 手动解压 wheel 到 site-packages写入install_metadata.toml记录包名与来源仓库完成安装。更新组件dbgpts update package-name需要说明的是update命令在 CLI 层实际对应 cli.py 中的update_repo——它面向的是**仓库repo**而非单个包不带参数时更新所有仓库-r repo指定更新某一个仓库repo all也会触发全量更新。其实现为对每个仓库目录执行git pull见 repo.py 的update_repo()。因此在日常实践中更新某个组件的推荐路径是先dbgpts update同步仓库元数据再dbgpts reinstall package-name重新安装该组件以获取最新版本。卸载组件dbgpts uninstall package-name卸载流程uninstall()若组件未安装会直接报错否则在安装目录下执行pip uninstall name -y清理 Python 包随后删除安装目录。重装组件dbgpts reinstall package-namereinstall()的语义是uninstallinstall的组合同样支持-r/--repo与-U/--update选项适合在组件升级后刷新本地版本。仓库repo管理除了包本身CLI 还提供了完整的仓库管理能力同样注册在dbgpt repo下# 列出所有已配置的仓库 dbgpts list # 添加一个新仓库git 地址或本地目录 dbgpts add --url git-or-local-path [-r repo-name] [-b branch] # 更新仓库不带参数更新全部-r 指定单个 dbgpts update [-r repo] # 移除仓库 dbgpts remove repo-name对应源码中的add_repo()仓库名必须形如group/name如eosphoros/dbgptsURL 以http或git开头时执行git clone若是本地目录则创建软链接。当没有任何仓库时安装/列出命令会自动拉取默认仓库eosphoros/dbgpts见_install_default_repos_if_no_repos()与 base.py 中的DEFAULT_REPO_MAP。使用模板新建组件dbgpts app -n name [-l label] [-d description] [-t type] [--definition_type json|python] [-C directory]对应dbgpt new app别名其中-n/--name必填组件名称-l/--label展示名称默认由 name 自动生成-、_替换为空格后转标题格式-d/--description描述默认空-t/--type类型取自click.Choice(DEFAULT_PACKAGE_TYPES)即agent / app / operator / flow / resource默认flow--definition_type定义方式json或python默认json注意除flow外其余类型强制为python-C/--directory工作目录默认当前目录。在 Web UI 中使用 dbgpts组件安装完成后DB-GPT Web 端会自动发现并展示它们Apps出现在应用商店App Store中Operators出现在 AWEL Flow 编辑器的算子面板中Workflow templates可导入 Flow 编辑器Agents可在创建多智能体应用时被选用。Web 端的实现位于 web/pages/construct/dbgpts/index.tsx该页面通过postDbgptsHubUpdate、postDbgptsQuery、postDbgptsInstall、postDbgptsMy、postDbgptsUninstall等 API 与后端交互提供市场market与我的my两个视图支持搜索、按类型过滤、安装/卸载操作。后端则由 dbgpts/hub/service/service.py 提供服务其refresh_hub_from_git()复用list_dbgpts()扫描仓库中的组件并入库。这套安装即自动出现在 Web UI的机制核心依赖运行时的加载器DBGPTsLoader见 loader.py。它是一个系统组件name dbgpt_dbgpts_loader在应用启动前加载一次已安装的包之后默认每 10 秒load_dbgpts_interval10重新扫描安装目录并自动完成以下注册agent包将包内继承ConversableAgent的类注册到agent_managerresource包将函数工具与Resource实例/类注册到resource_managerflow包转换为FlowPanel供 Flow 编辑器以只读、可导入的方式展示editable: False由_flow_package_to_flow_panel()实现。仓库目录结构dbgpts 社区仓库按组件类型组织目录dbgpts/ ├── apps/ # 完整应用 ├── operators/ # AWEL 算子 ├── workflow/ # 工作流模板 └── agents/ # 智能体定义结合本仓库源码实际约定比这更完整——包含resources目录打包函数工具与 Agent 资源并且每个包目录下必须存在dbgpts.toml元数据文件才会被 CLI 扫描与识别见 repo.py 的check_with_retry()/list_repo_apps()。包的元数据文件dbgpts.toml结构对应 loader.py 的parse_package_metadata()如下[flow] # 或 [agent] / [operator] / [resource] label My Flow name my_flow version 0.1.0 description A example flow authors [] definition_type json # 或 python [json_config] file_path definition/flow_definition.json # definition_typejson 时必填其中name、label、package_type、version、description、path、root、repo、package是 BasePackage 的核心字段安装目录下还会生成install_metadata.toml记录name与来源repo它是判断一个目录是否为已安装包的关键标志。创建自己的 dbgpts 包推荐使用模板命令快速生成符合规范的包骨架# 生成一个 flow 类型的包JSON 定义 dbgpts app -n my_flow -l My Flow -d A example flow -t flow --definition_type json # 生成一个 operator 类型的包Python 定义 dbgpts app -n hello_operator -t operator命令生成的骨架由 template.py 的create_template()完成会按TYPE_TO_PACKAGE的映射在工作目录下创建workflow/、operators/、agents/、resources/等子目录并使用uv init其次 poetry、最后手工创建初始化 Python 工程同时产出dbgpts.toml组件元数据上述示例即来自此处MANIFEST.in包含dbgpts.toml与*/definition/*.json确保构建时元数据被打包类型对应的__init__.py模板代码。以 operator 为例模板会生成一个带 AWELViewMetadata元数据的HelloWorldOperator(MapOperator[str, str])以 agent 为例会生成继承ConversableAgent的HelloWorldSpeakerAgent与配套Action。这些模板代码可直接运行是学习自定义组件写法的最佳起点。若选择纯手工创建一个 flowJSON 定义包的最小结构为my_flow/ ├── dbgpts.toml # 元数据[flow] 段 json_config.file_path ├── pyproject.toml # 构建配置setuptools/poetry 均可 ├── MANIFEST.in # 打包包含 dbgpts.toml 与定义文件 └── my_flow/ ├── __init__.py └── definition/ └── flow_definition.json # AWEL 流程图 JSON节点/边/视图随后将包提交到 dbgpts 社区仓库即可共享请遵循仓库目录约定放置包、确保包含元数据文件dbgpts.toml并提交 Pull Request。安装方的加载链路会自动完成剩余工作——DBGPTsLoader每 10 秒扫描安装目录将 JSON 定义的 flow 解析为可导入编辑器的FlowPanel将 Python 定义的 flow 直接加载为DAG对象将 agent/operator/resource 注册到对应管理器。延伸阅读构建 AWEL 工作流AWEL FlowMCP 工具集成MCP Protocol深入理解 dbgpts 加载器与包模型loader.py、repo.py、template.py安装流程的测试验证test_dbgpts_repo.py覆盖构建失败即中止安装wheel 安装失败不落盘元数据等关键行为【免费下载链接】DB-GPTopen-source agentic AI data assistant for the next generation of AI Data products.项目地址: https://gitcode.com/GitHub_Trending/db/DB-GPT创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
