前言¶
在 Windows 上部署和使用 RAGFlow 时,开发者需要手动操作 Docker、注册管理员、创建 API Key、配置模型、管理知识库,每一步都可能遇到环境不一致或命令遗漏的问题。RAGFlow Workbench 针对这些痛点,通过命令行方式把从安装到日常运维的完整流程自动化。
是什么¶
RAGFlow Workbench 是一个面向 Windows 平台的 RAGFlow 全流程自动化工具包。它由社区开发者 user_cbf9f659 维护,版本为 1.0.0,基于通用 SKILL.md 格式开发。工具通过命令行完成环境检查、管理员引导、模型配置、知识库 CRUD 等操作,无需手动操作 Web 界面,也不必记忆复杂的 API 调用。
核心功能¶
环境检查¶
对 Docker、容器、API 和 Web UI 进行四维健康检查,输出结构化的健康报告。
管理员引导¶
自动完成管理员注册、登录、JWT 获取和 API Key 创建,首次使用后通过 .env 文件保存凭据,后续会话自动跳过引导步骤。
模型配置¶
一键设置 Embedding、Chat、Rerank 模型,支持模型参数的快速配置。
知识库 CRUD¶
支持知识库的创建、查询、更新、删除操作,删除操作强制二次确认,避免误删。
文档管理¶
提供文档上传、列表、更新、删除以及批量操作功能,支持多种文档格式。
解析生命周期¶
发起、停止文档解析,实时追踪解析状态,解析失败时自动提供错误信息引导排查。
知识检索¶
支持语义检索、多库混合检索、KG 增强检索和 Rerank 等多种检索方式。
对话创建¶
绑定知识库与对话模型,支持自定义系统提示词。
安装与启用¶
工具使用 uv 运行 Python 脚本,通过命令行执行所有操作。
uv run python scripts/*.py --json
--json 参数用于输出结构化结果,方便与其他工具集成。首次使用时,工具会引导完成环境检查和初始化配置。
典型用法¶
一键检查环境¶
运行脚本后,工具会自动检测 Docker Desktop 和 RAGFlow 容器状态,输出四维健康报告。
自动注册管理员¶
在引导模式下,工具会提示输入管理员信息,自动完成注册、登录和 API Key 生成,并将凭据写入 .env 文件。
创建知识库¶
通过命令行指定知识库名称和配置,工具会自动完成知识库的创建和初始化。
上传文档¶
支持批量上传文档到指定知识库,工具会自动发起解析流程并追踪状态。
适用场景¶
- 在 Windows 环境中快速部署 RAGFlow
- 需要频繁管理知识库和文档的开发者
- 希望通过命令行集成 RAGFlow 操作的自动化流程
注意事项¶
- 工具专为 Windows 环境设计,依赖 Docker Desktop 和 RAGFlow 容器运行
- 删除操作需要手动确认,请谨慎使用
- 首次使用需要完成引导配置,后续会话会自动跳过引导步骤
小结¶
RAGFlow Workbench 把 Windows 上使用 RAGFlow 的繁琐操作封装成命令行工具,从环境检查到知识库管理实现全流程自动化。对于需要频繁操作 RAGFlow 的开发者来说,可以显著提升效率。
官方地址:https://www.skillhub.cn/skills/user_cbf9f659/ragflow-workbench