From de10ba87ae405cb33730f388bb811cda064d7247 Mon Sep 17 00:00:00 2001 From: fujie Date: Sun, 15 Mar 2026 18:48:27 +0800 Subject: [PATCH] docs(batch-install-plugins): restructure README with quick start examples - Reorganize Quick Start section to showcase 6 popular repositories with copy-paste examples - Remove duplicate 'Popular Public Repositories' section - Consolidate Installation Workflow and Usage Examples for clarity - Add suurt8ll/open_webui_functions to popular collection list - Update both English and Chinese documentation with consistent formatting - Sync documentation mirrors to docs/plugins/ Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../tools/batch-install-plugins-tool.md | 75 +++++++----------- .../tools/batch-install-plugins-tool.zh.md | 77 +++++++------------ plugins/tools/batch-install-plugins/README.md | 75 +++++++----------- .../tools/batch-install-plugins/README_CN.md | 77 +++++++------------ 4 files changed, 110 insertions(+), 194 deletions(-) diff --git a/docs/plugins/tools/batch-install-plugins-tool.md b/docs/plugins/tools/batch-install-plugins-tool.md index ffb18b9..f702de4 100644 --- a/docs/plugins/tools/batch-install-plugins-tool.md +++ b/docs/plugins/tools/batch-install-plugins-tool.md @@ -59,69 +59,48 @@ User Input Each request handles one repository. To mix repositories, send another request after the previous installation completes. -### Example Installation Sequence +## Quick Start: Install Popular Collections -1. **Start with My Collection** - ``` - "Install all plugins from Fu-Jie/openwebui-extensions" - ``` - Review the confirmation dialog, approve, and the plugins are installed. +Copy any of these prompts and paste them into your chat: -2. **Add a Community Collection** - ``` - "Install all plugins from iChristGit/OpenWebui-Tools" - ``` - Add more plugins from a different repository. Already installed plugins are updated seamlessly. +``` +# Install all from my collection (default) +Install all plugins -3. **Install a Specific Type** - ``` - "Install only pipe plugins from Haervwe/open-webui-tools" - ``` - Pick specific plugin types from another repository, or exclude certain keywords. +# Add popular community tools +Install all plugins from iChristGit/OpenWebui-Tools -4. **Use Your Own Repository** - ``` - "Install all plugins from your-username/your-collection" - ``` - Works with any public GitHub repository in `owner/repo` format. +# Add utility-focused extensions +Install all plugins from Haervwe/open-webui-tools + +# Add mixed community implementations +Install all plugins from Classic298/open-webui-plugins + +# Add function-based plugins +Install all plugins from suurt8ll/open_webui_functions + +# Add OpenRouter pipe integration +Install all plugins from rbb-dev/Open-WebUI-OpenRouter-pipe +``` + +Each line is a separate request. Already installed plugins are automatically updated. ## Usage Examples -Each line below is a separate request: +For more advanced usage patterns: ``` -# Install from my default collection -"Install all plugins" - -# Add another repository in a new request -"Install all plugins from iChristGit/OpenWebui-Tools" - -# Add only tools from a different repository -"Install only tool plugins from Haervwe/open-webui-tools" - -# Continue building your setup with another request +# Filter by plugin type +"Install only tool plugins from iChristGit/OpenWebui-Tools" "Install only action plugins from Classic298/open-webui-plugins" -# Filter out unwanted plugins +# Exclude specific plugins "Install all plugins from Haervwe/open-webui-tools, exclude_keywords=test,deprecated" -# Install from your own public repository +# Install from your own repository "Install all plugins from your-username/my-plugin-collection" ``` -## Popular Public Repositories - -The tool works with any public GitHub repository in `owner/repo` format. Popular starting points include: - -- `Fu-Jie/openwebui-extensions` - My personal collection and the default source -- `iChristGit/OpenWebui-Tools` - Comprehensive tools and plugins -- `Haervwe/open-webui-tools` - Utility-focused extensions -- `Classic298/open-webui-plugins` - Mixed community plugins -- `suurt8ll/open_webui_functions` - Function-based plugins -- `rbb-dev/Open-WebUI-OpenRouter-pipe` - OpenRouter pipe integration - -To combine repositories, run the tool again with a different `repo` after the previous installation completes. - ## Default Repository When no repository is specified, the tool uses `Fu-Jie/openwebui-extensions` (my personal collection). @@ -157,4 +136,4 @@ User confirmation dialogs have a default timeout of **2 minutes (120 seconds)**, ## Support -If this plugin has been useful, a star on [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions) is a big motivation for me. Thank you for the support. +⭐ If this plugin has been useful, a star on [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions) is a big motivation for me. Thank you for the support. diff --git a/docs/plugins/tools/batch-install-plugins-tool.zh.md b/docs/plugins/tools/batch-install-plugins-tool.zh.md index 4b359e8..cdd7dfe 100644 --- a/docs/plugins/tools/batch-install-plugins-tool.zh.md +++ b/docs/plugins/tools/batch-install-plugins-tool.zh.md @@ -59,69 +59,48 @@ 每次请求处理一个仓库。如需混合多个来源，请在上一次安装完成后再发起下一次请求。 -### 安装序列示例 +## 快速开始：安装热门插件集 -1. **先从我的合集开始** - ``` - "安装 Fu-Jie/openwebui-extensions 中的所有插件" - ``` - 查看确认对话框，批准后插件开始安装。 +复制以下任一提示词，粘贴到你的对话框中： -2. **再添加社区合集** - ``` - "从 iChristGit/OpenWebui-Tools 安装所有插件" - ``` - 从不同仓库添加更多插件。已安装的插件会无缝更新。 +``` +# 安装我的默认集合 +安装所有插件 -3. **按类型继续安装** - ``` - "从 Haervwe/open-webui-tools 仅安装 pipe 插件" - ``` - 从另一个仓库选择特定类型的插件，或排除某些关键词。 +# 添加热门社区工具 +从 iChristGit/OpenWebui-Tools 安装所有插件 -4. **使用你自己的仓库** - ``` - "从 your-username/your-collection 安装所有插件" - ``` - 支持任何公开的 GitHub 仓库，格式为 `owner/repo`。 +# 添加实用工具扩展 +从 Haervwe/open-webui-tools 安装所有插件 + +# 添加混合社区实现 +从 Classic298/open-webui-plugins 安装所有插件 + +# 添加基于函数的插件 +从 suurt8ll/open_webui_functions 安装所有插件 + +# 添加 OpenRouter 管道集成 +从 rbb-dev/Open-WebUI-OpenRouter-pipe 安装所有插件 +``` + +每一行是一个独立的请求。已安装的插件会自动更新。 ## 使用示例 -下面每一行都是一次独立请求： +更多高级用法： ``` -# 从默认合集安装 -"安装所有插件" +# 按插件类型过滤 +"从 iChristGit/OpenWebui-Tools 仅安装 tool 插件" +"从 Classic298/open-webui-plugins 仅安装 action 插件" -# 在下一次请求中加入其他仓库 -"从 iChristGit/OpenWebui-Tools 安装所有插件" - -# 从其他仓库只安装工具 -"从 Haervwe/open-webui-tools 仅安装 tool 插件" - -# 再继续补充另一类插件 -"从 Classic298/open-webui-plugins 安装仅 action 插件" - -# 过滤不想安装的插件 +# 排除特定插件 "从 Haervwe/open-webui-tools 安装所有插件, exclude_keywords=test,deprecated" -# 从你自己的公开仓库安装 +# 从你自己的仓库安装 "从 your-username/my-plugin-collection 安装所有插件" ``` -## 热门公开仓库 - -该工具支持任何公开 GitHub 仓库，格式为 `owner/repo`。这些都是不错的起点： - -- `Fu-Jie/openwebui-extensions` - 我的个人合集，也是默认来源 -- `iChristGit/OpenWebui-Tools` - 全面的工具和插件集合 -- `Haervwe/open-webui-tools` - 偏工具型的扩展集合 -- `Classic298/open-webui-plugins` - 混合型社区插件集合 -- `suurt8ll/open_webui_functions` - 基于函数的插件集合 -- `rbb-dev/Open-WebUI-OpenRouter-pipe` - OpenRouter pipe 集成 - -如需混合多个来源，请在上一次安装完成后，换一个 `repo` 再调用一次工具。 - ## 默认仓库 未指定仓库时，工具会使用 `Fu-Jie/openwebui-extensions`（我的个人合集）。 @@ -157,4 +136,4 @@ ## 支持 -如果这个插件对你有帮助，欢迎到 [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions) 点个 Star，这将是我持续改进的动力，感谢支持。 +⭐ 如果这个插件对你有帮助，欢迎到 [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions) 点个 Star，这将是我持续改进的动力，感谢支持。 diff --git a/plugins/tools/batch-install-plugins/README.md b/plugins/tools/batch-install-plugins/README.md index ffb18b9..f702de4 100644 --- a/plugins/tools/batch-install-plugins/README.md +++ b/plugins/tools/batch-install-plugins/README.md @@ -59,69 +59,48 @@ User Input Each request handles one repository. To mix repositories, send another request after the previous installation completes. -### Example Installation Sequence +## Quick Start: Install Popular Collections -1. **Start with My Collection** - ``` - "Install all plugins from Fu-Jie/openwebui-extensions" - ``` - Review the confirmation dialog, approve, and the plugins are installed. +Copy any of these prompts and paste them into your chat: -2. **Add a Community Collection** - ``` - "Install all plugins from iChristGit/OpenWebui-Tools" - ``` - Add more plugins from a different repository. Already installed plugins are updated seamlessly. +``` +# Install all from my collection (default) +Install all plugins -3. **Install a Specific Type** - ``` - "Install only pipe plugins from Haervwe/open-webui-tools" - ``` - Pick specific plugin types from another repository, or exclude certain keywords. +# Add popular community tools +Install all plugins from iChristGit/OpenWebui-Tools -4. **Use Your Own Repository** - ``` - "Install all plugins from your-username/your-collection" - ``` - Works with any public GitHub repository in `owner/repo` format. +# Add utility-focused extensions +Install all plugins from Haervwe/open-webui-tools + +# Add mixed community implementations +Install all plugins from Classic298/open-webui-plugins + +# Add function-based plugins +Install all plugins from suurt8ll/open_webui_functions + +# Add OpenRouter pipe integration +Install all plugins from rbb-dev/Open-WebUI-OpenRouter-pipe +``` + +Each line is a separate request. Already installed plugins are automatically updated. ## Usage Examples -Each line below is a separate request: +For more advanced usage patterns: ``` -# Install from my default collection -"Install all plugins" - -# Add another repository in a new request -"Install all plugins from iChristGit/OpenWebui-Tools" - -# Add only tools from a different repository -"Install only tool plugins from Haervwe/open-webui-tools" - -# Continue building your setup with another request +# Filter by plugin type +"Install only tool plugins from iChristGit/OpenWebui-Tools" "Install only action plugins from Classic298/open-webui-plugins" -# Filter out unwanted plugins +# Exclude specific plugins "Install all plugins from Haervwe/open-webui-tools, exclude_keywords=test,deprecated" -# Install from your own public repository +# Install from your own repository "Install all plugins from your-username/my-plugin-collection" ``` -## Popular Public Repositories - -The tool works with any public GitHub repository in `owner/repo` format. Popular starting points include: - -- `Fu-Jie/openwebui-extensions` - My personal collection and the default source -- `iChristGit/OpenWebui-Tools` - Comprehensive tools and plugins -- `Haervwe/open-webui-tools` - Utility-focused extensions -- `Classic298/open-webui-plugins` - Mixed community plugins -- `suurt8ll/open_webui_functions` - Function-based plugins -- `rbb-dev/Open-WebUI-OpenRouter-pipe` - OpenRouter pipe integration - -To combine repositories, run the tool again with a different `repo` after the previous installation completes. - ## Default Repository When no repository is specified, the tool uses `Fu-Jie/openwebui-extensions` (my personal collection). @@ -157,4 +136,4 @@ User confirmation dialogs have a default timeout of **2 minutes (120 seconds)**, ## Support -If this plugin has been useful, a star on [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions) is a big motivation for me. Thank you for the support. +⭐ If this plugin has been useful, a star on [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions) is a big motivation for me. Thank you for the support. diff --git a/plugins/tools/batch-install-plugins/README_CN.md b/plugins/tools/batch-install-plugins/README_CN.md index 4b359e8..cdd7dfe 100644 --- a/plugins/tools/batch-install-plugins/README_CN.md +++ b/plugins/tools/batch-install-plugins/README_CN.md @@ -59,69 +59,48 @@ 每次请求处理一个仓库。如需混合多个来源，请在上一次安装完成后再发起下一次请求。 -### 安装序列示例 +## 快速开始：安装热门插件集 -1. **先从我的合集开始** - ``` - "安装 Fu-Jie/openwebui-extensions 中的所有插件" - ``` - 查看确认对话框，批准后插件开始安装。 +复制以下任一提示词，粘贴到你的对话框中： -2. **再添加社区合集** - ``` - "从 iChristGit/OpenWebui-Tools 安装所有插件" - ``` - 从不同仓库添加更多插件。已安装的插件会无缝更新。 +``` +# 安装我的默认集合 +安装所有插件 -3. **按类型继续安装** - ``` - "从 Haervwe/open-webui-tools 仅安装 pipe 插件" - ``` - 从另一个仓库选择特定类型的插件，或排除某些关键词。 +# 添加热门社区工具 +从 iChristGit/OpenWebui-Tools 安装所有插件 -4. **使用你自己的仓库** - ``` - "从 your-username/your-collection 安装所有插件" - ``` - 支持任何公开的 GitHub 仓库，格式为 `owner/repo`。 +# 添加实用工具扩展 +从 Haervwe/open-webui-tools 安装所有插件 + +# 添加混合社区实现 +从 Classic298/open-webui-plugins 安装所有插件 + +# 添加基于函数的插件 +从 suurt8ll/open_webui_functions 安装所有插件 + +# 添加 OpenRouter 管道集成 +从 rbb-dev/Open-WebUI-OpenRouter-pipe 安装所有插件 +``` + +每一行是一个独立的请求。已安装的插件会自动更新。 ## 使用示例 -下面每一行都是一次独立请求： +更多高级用法： ``` -# 从默认合集安装 -"安装所有插件" +# 按插件类型过滤 +"从 iChristGit/OpenWebui-Tools 仅安装 tool 插件" +"从 Classic298/open-webui-plugins 仅安装 action 插件" -# 在下一次请求中加入其他仓库 -"从 iChristGit/OpenWebui-Tools 安装所有插件" - -# 从其他仓库只安装工具 -"从 Haervwe/open-webui-tools 仅安装 tool 插件" - -# 再继续补充另一类插件 -"从 Classic298/open-webui-plugins 安装仅 action 插件" - -# 过滤不想安装的插件 +# 排除特定插件 "从 Haervwe/open-webui-tools 安装所有插件, exclude_keywords=test,deprecated" -# 从你自己的公开仓库安装 +# 从你自己的仓库安装 "从 your-username/my-plugin-collection 安装所有插件" ``` -## 热门公开仓库 - -该工具支持任何公开 GitHub 仓库，格式为 `owner/repo`。这些都是不错的起点： - -- `Fu-Jie/openwebui-extensions` - 我的个人合集，也是默认来源 -- `iChristGit/OpenWebui-Tools` - 全面的工具和插件集合 -- `Haervwe/open-webui-tools` - 偏工具型的扩展集合 -- `Classic298/open-webui-plugins` - 混合型社区插件集合 -- `suurt8ll/open_webui_functions` - 基于函数的插件集合 -- `rbb-dev/Open-WebUI-OpenRouter-pipe` - OpenRouter pipe 集成 - -如需混合多个来源，请在上一次安装完成后，换一个 `repo` 再调用一次工具。 - ## 默认仓库 未指定仓库时，工具会使用 `Fu-Jie/openwebui-extensions`（我的个人合集）。 @@ -157,4 +136,4 @@ ## 支持 -如果这个插件对你有帮助，欢迎到 [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions) 点个 Star，这将是我持续改进的动力，感谢支持。 +⭐ 如果这个插件对你有帮助，欢迎到 [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions) 点个 Star，这将是我持续改进的动力，感谢支持。