一句话定义
@fastgpt-plugin/cli是FastGPT官方提供的插件开发命令行工具，用于快速生成插件项目骨架与配套配置文件，同时包含FastGPT插件开发相关CLI命令及API变更的官方说明。
在FastGPT里怎么用
可通过pnpx @fastgpt-plugin/cli create命令创建插件，支持两种方式：
- 带参数创建：单工具插件执行
pnpx @fastgpt-plugin/cli create my-tool --type tool --cwd packages/tools；工具集插件执行pnpx @fastgpt-plugin/cli create my-tool-suite --type tool-suite --cwd packages/tools。 - 交互式创建：进入目标目录后执行无参数命令
pnpx @fastgpt-plugin/cli create。
CLI创建后会生成以下文件：index.ts为插件入口，默认导出defineTool()或defineToolSet()；package.json包含依赖及build、build:dev、pack、test脚本；tsconfig.json为TypeScript配置；vitest.config.ts为测试配置；README.md为插件说明；logo.svg为插件主图标。 API相关变更需按以下要求处理：
- 私有化部署的旧自定义文件解析方案需更新为最新环境变量配置方案。
- 旧版本地文件上传API
/api/core/dataset/collection/create/file已弃用，替换为/api/core/dataset/collection/create/localFile。 - 外部文件库相关API停止维护并即将弃用，可通过API文件库替代。
- 带有
trainingType字段的接口，未来仅支持chunk和QA两种模式，增强索引模式需设置单独字段autoIndexes，旧版trainingType=auto代码需尽快变更。
容易搞错的地方
- 混淆单工具插件与工具集插件的
--type参数取值，需分别使用tool和tool-suite。 - 创建插件时未正确指定
--type参数，导致生成的插件类型不符合预期。 - 未通过
--cwd参数指定目标目录，导致插件目录生成位置错误。 - 误使用旧版的
config.ts、versionList和bun run build:pkg方式进行开发。 - 未及时更新旧版API接口配置，如文件上传API、
trainingType字段，导致功能无法正常运行。 - 未同步更新私有化部署的旧自定义文件解析方案，造成部署兼容异常。
来源： FastGPT 官方来源
来源： FastGPT 官方来源
适用性与版本范围
本页适用于官方来源记录的 术语表 场景。执行变更前，需核对 FastGPT、依赖、API 与部署版本。
安全护栏
凭证与私密数据使用 [REDACTED_CREDENTIAL] 占位符。执行操作前需核对文档的环境与版本。
回滚指引
恢复变更前的技术内容权威快照、已保存配置与数据快照，再执行最小验证场景。