关于 aio-ffcpe-cli
aio-ffcpe-cli 是用于安装和操作 Adobe I/O CLI 中 FFCPE 目录插件的 Agent 技能。它涵盖命令选择、标志、身份验证上下文,以及从 App Builder 部署到目录注册的步骤。
主要功能
- 01插件安装与故障排查
- 02FFCPE 目录命令指引
- 03命令标志与 JSON 输出
- 04身份验证与组织上下文
- 05从 App Builder 部署到注册的步骤
适用场景
- 01验证并注册自定义操作
- 02检查、更新或停用目录操作
- 03排查 CLI 身份验证或组织上下文
- 04将已部署的 App Builder 端点关联到目录条目
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ adobe/ aio-cli-plugin-ffcpe --skill aio-ffcpe-cli安装后在 Claude Code 中输入/aio-ffcpe-cli确认已加载。
详细介绍
aio-cli-plugin-ffcpe(FFCPE CLI)
此仓库是 Adobe I/O CLI 的 oclif 插件。主题:ffcpe — Firefly Creative Production for Enterprise(FFCPE) — 专注于自定义操作的 run-workflow Catalog API。
**旧版名称:**内部文档和较早的文档有时会写作 Workflow Builder,或在截图中使用旧版主题名称。这指的是同一项功能;当前品牌和 aio 主题均为 ffcpe。
何时使用此技能
- 安装或排查插件问题
- 选择合适的
aio ffcpe catalog …命令 - 说明标志(
--base-url、--org-id、--api-key、--json等) - 了解如何解析身份验证和组织上下文
设置
1. 安装 Adobe I/O CLI(aio)
需要 Node.js 18+。
npm install -g @adobe/aio-cli
aio --version
2. 安装此插件(@adobe/aio-cli-plugin-ffcpe)
aio plugins:install @adobe/aio-cli-plugin-ffcpe
也可以从 Git 安装(分支或内部仓库):
aio plugins:install https://github.com/adobe/aio-cli-plugin-ffcpe
3. 验证并进行身份验证
aio ffcpe catalog --help
aio login
aio console org select
如果找不到 aio ffcpe,请运行 aio plugins 并确认已安装此软件包。
基础 URL
- 默认值:
https://run-workflow.adobe.io - **覆盖方式:**环境变量
AIO_FFCPE_CATALOG_BASE_URL,或在 catalog 命令中使用标志--base-url(-u)。
命令(catalog)
| 命令 | 用途 |
|---|---|
aio ffcpe catalog validate | 本地验证 catalog 条目 JSON(通常为 <action-name>.entry.json)。使用 --file / -f。 |
aio ffcpe catalog register | 从 JSON 文件 POST 新的 catalog 条目。先进行验证;可选使用 --strict,在验证出现警告时失败。 |
aio ffcpe catalog inspect ACTIONTYPE | GET 单个操作;可选使用 --version 指定 semver。 |
aio ffcpe catalog list | GET catalog 操作(支持命令帮助中列出的筛选条件)。 |
aio ffcpe catalog update ACTIONTYPE | PUT 完整替换定义。 |
aio ffcpe catalog disable ACTIONTYPE | 禁用(通常会在 FFCPE 工作流 UI 中隐藏该操作)。 |
aio ffcpe catalog enable ACTIONTYPE | 重新启用已禁用的操作。 |
aio ffcpe catalog delete ACTIONTYPE | DELETE;使用 --version 仅删除一个 semver。 |
运行 aio ffcpe catalog --help 或 aio ffcpe catalog <command> --help,查看准确的标志和示例。
常用标志
--org-id— 覆盖x-gw-ims-org-id(默认值来自aio console org select)。--api-key— 按需覆盖x-api-key。--json— 在支持时输出原始 API JSON。
编写 catalog 条目
此 CLI 不会交互式生成条目。请使用 ffcpe-catalog-entry-json 技能(如果已安装插件,也可使用 /aio-ffcpe-skills:ffcpe-catalog-entry-json)。
**App Builder 仓库的推荐布局:**将每个操作的 catalog JSON 存为 <action-name>.entry.json,并与 <action-name>.web.* 和 <action-name>.worker.* 放在一起(例如 actions/resize-image/resize-image.entry.json)。这样可将同一自定义操作的实现和注册文件归在一起。参见 ffcpe-custom-node-sdk 中的 ffcpe-app-builder-actions。
然后进行验证并注册:
aio ffcpe catalog validate -f ./actions/resize-image/resize-image.entry.json
aio ffcpe catalog register -f ./actions/resize-image/resize-image.entry.json
注册前:连接 App Builder 项目
注册之前,必须先部署 App Builder 应用,并将本地项目连接到 Console 工作区。
Console 项目命名
| 规则 | 详情 |
|---|---|
| 仅限字母和数字 | 不接受连字符:demo-qr-app 会报错 Project name … is invalid |
| 最多 20 个字符 | 名称过长时会在创建时失败 |
| 名称 ≠ 软件包 | Console 项目(例如 demoQrFfcpe)可以与 OpenWhisk runtimeManifest package(例如 demo-qr-custom-ffcpe-nodes)不同 |
新建项目时会自动创建 Stage 和 Production 工作区。
Console CLI 标志注意事项
aio console workspace 命令的标志格式不一致——使用错误的标志会抛出 NonExistentFlagsError:
| 命令 | 正确的标志 |
|---|---|
aio console workspace create | --projectName <name>(必需),--name <name>(必需) |
aio console workspace select | 位置参数 [NAME_OR_ID] + 可选的 --projectId <id> |
aio console workspace list | --projectId <id> —— 没有 --projectName 标志 |
aio console workspace download | 可选的位置参数目标路径 |
配置、构建、部署
aio console project create -n myproject -t "My FFCPE App" --json
aio console project select myproject
aio console workspace select Stage --projectId <PROJECT_ID>
aio console workspace download myproject-Stage.json
echo 'myproject-Stage.json' >> .gitignore
aio app use myproject-Stage.json --overwrite --no-input
aio app build
aio app deploy
如果 .env 已由 aio app init 创建,请在 aio app use 中使用 --overwrite --no-input,否则 CLI 会进行交互式提示,在 Agent/CI 会话中可能会卡住。
下载的 JSON 文件包含客户端凭据和 API 密钥。自动生成的 .gitignore 不会自动涵盖此文件(它只涵盖 console.json 和 .env*)。下载后立即添加准确的文件名,或添加模式 [0-9]*-*-*.json。
部署后:端点 → 目录 → 注册
- 从部署输出中复制每个Web Action 基础 URL。
- 在
<action-name>.entry.json中设置submitEndpoint={base}/submit、statusEndpoint={base}/status。 - 使用默认 SDK 路由身份验证时,将
authentication设置为ims_service_token(参见ffcpe-catalog-entry-json)。 - 注册:
aio console org select
aio ffcpe catalog validate -f ./actions/my-action/my-action.entry.json
aio ffcpe catalog register -f ./actions/my-action/my-action.entry.json
# or, if actionType already exists:
aio ffcpe catalog update my-action -f ./actions/my-action/my-action.entry.json
完整的 init-bare → 部署 → 注册流程,请参阅 ffcpe-app-builder-actions 技能。
深入文档
skills/README.md—— Agent 技能(Claude/命令、Cursor 路径、通过npx skills安装)。.cursor/ffcpe-catalog/SKILL.md—— 通过aio ffcpe catalog执行目录操作(底层使用相同的 HTTP API;不要手动编写 curl 命令)。