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、またはカタログコマンドのフラグ--base-url**（-u）。

コマンド（カタログ）

コマンド	用途
aio ffcpe catalog validate	カタログエントリー JSON（通常は**<action-name>.entry.json**）をローカルで検証します。--file / -fを使用します。
aio ffcpe catalog register	JSON ファイルから新しいカタログエントリーを POST します。最初に検証し、必要に応じて**--strict**を指定すると、検証時の警告で失敗するようにできます。
aio ffcpe catalog inspect ACTIONTYPE	1つのアクションを GET します。特定の semver を指定する場合は、任意で**--version**を指定します。
aio ffcpe catalog list	カタログのアクションを GET します（コマンドのヘルプに記載されたフィルターに対応）。
aio ffcpe catalog update ACTIONTYPE	定義全体を置き換える PUT を実行します。
aio ffcpe catalog disable ACTIONTYPE	無効化します（通常は FFCPE ワークフロー UI に表示されなくなります）。
aio ffcpe catalog enable ACTIONTYPE	無効化されたアクションを再び有効にします。
aio ffcpe catalog delete ACTIONTYPE	DELETE を実行します。1つの semver のみを削除する場合は**--version**を使用します。

フラグと使用例の詳細は、**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 を出力します。

カタログエントリーの作成

この CLI では、対話形式でエントリーをひな形から作成することはできません。**ffcpe-catalog-entry-jsonスキルを使用するか（プラグインがインストールされている場合は/aio-ffcpe-skills:ffcpe-catalog-entry-json**を使用します）。

App Builder リポジトリで推奨される配置： 各アクションのカタログ JSON は、<action-name>.web.*および<action-name>.worker.*と同じ場所に<action-name>.entry.jsonとして保存します（例：actions/resize-image/resize-image.entry.json）。こうすることで、1つのカスタムアクションの実装と登録をまとめられます。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パッケージ**（例：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

aio app init ですでに .env が作成されている場合は、aio app use に --overwrite --no-input を指定してください。指定しないと、CLI が対話形式の入力を求めるため、エージェント／CI セッションで停止することがあります。

ダウンロードした JSON ファイルには、クライアントの認証情報と API キーが含まれています。生成された .gitignore では、このファイルは自動的に除外されません（console.json と .env* のみが対象です）。ダウンロード後すぐに、正確なファイル名、またはパターン [0-9]*-*-*.json を追加してください。

デプロイ後：エンドポイント → カタログ → 登録

1. デプロイ出力から、各ウェブアクションのベース URL をコピーします。
2. <action-name>.entry.json で、submitEndpoint を {base}/submit、statusEndpoint を {base}/status に設定します。
3. デフォルトの SDK ルート認証を使用する場合は、authentication を ims_service_token に設定します（ffcpe-catalog-entry-json を参照）。
4. 登録します。

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 → deploy → register の一連の手順については、ffcpe-app-builder-actions スキルを参照してください。

詳細ドキュメント

• skills/README.md — エージェントスキル（Claude / コマンド、Cursor のパス、npx skills によるインストール）。
• .cursor/ffcpe-catalog/SKILL.md — aio ffcpe catalog によるカタログ操作（内部では同じ HTTP API を使用します。curl を手動で組み立てないでください）。