ChatGPT/FastGPT
1
0
Fork 0
mirror of https://github.com/labring/FastGPT.git synced 2025-10-14 07:00:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update dev system tool (#5486)

Browse Source
This commit is contained in:
Finley Ge
2025-08-20 19:00:48 +08:00
committed by GitHub
parent 1e7a1a738b
commit 6da65ea53d
3 changed files with 13 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
document/content/docs/introduction/development/design/design_plugin.mdx
View File

@@ -45,6 +45,7 @@ description: FastGPT 系统插件设计方案
- ...
- **type** 类型定义
- **utils** 工具
- **model** 模型预设
- **scripts** 脚本（编译、创建新工具）
- **sdk**: SDK 定义，供外部调用，发布到了 npm
- **src**: 运行时，express 服务

16
document/content/docs/introduction/guide/plugins/dev_system_tool.mdx
View File

@@ -16,11 +16,15 @@ FastGPT 系统工具项目从 4.10.0 版本后移动到独立的`fastgpt-plugin`
## 1. 准备工作
- Fork[fastgpt-plugin 项目](https://github.com/labring/fastgpt-plugin)
- 安装[Bun](https://bun.sh/)
- 本地拉取项目进行 Dev 开发。
- bun install
- bun run dev
- Fork [fastgpt-plugin 项目](https://github.com/labring/fastgpt-plugin)
- 安装 [Bun](https://bun.sh/)
- 部署一套 Minio，也可以直接使用 FastGPT 的 `docker-compose.yml` 中的 Minio。
- 本地 clone 项目 `git clone git@github.com:[your-github-username]/fastgpt-plugin.git`
- 拷贝示例环境变量文件，并修改连接到开发环境的 Minio `cp .env.example .env.local`
- 安装依赖 `bun install`
- 运行开发环境 `bun run dev`
在 dev 环境下，Bun 将监听修改并热更新。
## 2. 初始化一个新的工具/工具集
@@ -32,7 +36,7 @@ bun run new:tool
依据提示分别选择创建工具/工具集，以及目录名（使用 camelCase 小驼峰法命名）。
执行完后，系统会在 `modules/tool/packages/[your-tool-name]`下生成一个工具/工具集的目录。
执行完后，系统会在 `modules/tool/packages/[your-tool-name]` 下生成一个工具/工具集的目录。
系统工具 (Tool) 文件结构如下:

4
document/data/doc-last-modified.json
View File

@@ -81,7 +81,7 @@
"document/content/docs/introduction/guide/knowledge_base/websync.mdx": "2025-08-05T23:20:39+08:00",
"document/content/docs/introduction/guide/knowledge_base/yuque_dataset.mdx": "2025-07-23T21:35:03+08:00",
"document/content/docs/introduction/guide/plugins/bing_search_plugin.mdx": "2025-07-23T21:35:03+08:00",
"document/content/docs/introduction/guide/plugins/dev_system_tool.mdx": "2025-07-30T22:30:03+08:00",
"document/content/docs/introduction/guide/plugins/dev_system_tool.mdx": "2025-08-18T14:59:46+08:00",
"document/content/docs/introduction/guide/plugins/doc2x_plugin_guide.mdx": "2025-07-23T21:35:03+08:00",
"document/content/docs/introduction/guide/plugins/google_search_plugin_guide.mdx": "2025-07-23T21:35:03+08:00",
"document/content/docs/introduction/guide/plugins/searxng_plugin_guide.mdx": "2025-07-23T21:35:03+08:00",
@@ -103,7 +103,7 @@
"document/content/docs/upgrading/4-11/4110.mdx": "2025-08-05T23:20:39+08:00",
"document/content/docs/upgrading/4-11/4111.mdx": "2025-08-07T22:49:09+08:00",
"document/content/docs/upgrading/4-12/4120.mdx": "2025-08-12T22:45:19+08:00",
"document/content/docs/upgrading/4-12/4121.mdx": "2025-08-15T22:45:13+08:00",
"document/content/docs/upgrading/4-12/4121.mdx": "2025-08-15T22:53:06+08:00",
"document/content/docs/upgrading/4-8/40.mdx": "2025-08-02T19:38:37+08:00",
"document/content/docs/upgrading/4-8/41.mdx": "2025-08-02T19:38:37+08:00",
"document/content/docs/upgrading/4-8/42.mdx": "2025-08-02T19:38:37+08:00",