发布自定义 Piece

你可以使用 CLI 将自定义 Piece 发布到平台。此过程打包 Piece 并将其上传到指定的 API 端点。

工作原理

CLI 扫描 packages/pieces/ 目录以查找指定的 Piece。它检查 package.json 文件中的 name 和 version。如果该 Piece 尚未发布，则会构建、打包并通过 API 将其上传到平台。

使用方法

要发布一个 Piece，请按照以下步骤操作：

  1. 确保你拥有 API 密钥。在管理界面中导航到设置以生成。
  2. 通过克隆仓库安装 CLI。
  3. 运行以下命令：
npm run publish-piece-to-api
  1. 系统会询问三个问题来发布你的 Piece：
  • Piece 文件夹名称：与动作所在文件夹关联的名称。有助于在 Piece 内组织和分类动作。
  • API URL：Piece 将发布到的 API 端点 URL（例如：https://cloud.activepieces.com/api）。
  • API 密钥来源：API 密钥的来源。可以是 环境变量 (AP_API_KEY) 或 手动输入。

如果你选择 环境变量 (AP_API_KEY)，CLI 将使用 packages/server/api 目录下 .env 文件中的 API 密钥。

如果你选择 手动输入，系统将要求你输入 API 密钥。

示例：

npm run publish-piece-to-api

? 请输入 piece 文件夹名称：google-drive
? 请输入 API URL：https://cloud.activepieces.com/api
? 请输入 API 密钥来源：环境变量 (AP_API_KEY)

npm run publish-piece-to-api

? 请输入 piece 文件夹名称：google-drive
? 请输入 API URL：https://cloud.activepieces.com/api
? 请输入 API 密钥来源：手动输入
? 请输入 API 密钥：ap_1234567890abcdef1234567890abcdef