Skip to main content

CLI

Generated from oclif manifests in the ECP checkout (packages/cli operations and plugins/plugin-*/oclif.manifest.json). Do not hand-edit. Learn flags from ecp <command> --help when in doubt. Install with npm install -g @executioncontrolprotocol/cli (0.50.0 on latest). Contributors who are changing packages can build from source.

--json envelope

Every command accepts --json. Success prints { ok: true, data }. Failure prints { ok: false, error: { code, message, path, suggestions } } and a non-zero exit (0 success, 1 failed run, 2 usage, 3 validation, 4 plugin/environment load). There is no ecp test, ecp serve, ecp up, or root ecp encode / ecp decode. Format plugins expose ecp format-toon encode (and similar).

Plugin install (oclif)

ecp plugins install, ecp plugins link, and ecp plugins uninstall come from @oclif/plugin-plugins. First-party packages install without a prompt. Third-party plugins require approval (ECP_PLUGIN_DENIED if you refuse). Source installs need --allow-source.

Host commands

ecp compile

Compile a workflow to JSON Bundle and evaluate a workflow module (.ts or .js), or load .json, and emit the workflow manifest.

Args

Flags

Examples

ecp config secrets

Manage OS keychain secrets

Examples

ecp config secrets add

Add or replace a secret in the OS keychain Prompts interactively for the secret value by default. Use —value for non-interactive inline input.

Args

Flags

Examples

ecp config secrets get

Read a secret (redacted by default) Print a redacted preview, or the full value with —reveal.

Args

Flags

Examples

ecp config secrets list

List secret keys in the OS keychain Print stored secret keys (not values).

Examples

ecp config secrets remove

Remove a stored secret from the OS keychain Delete a secret by lookup key.

Args

Examples

ecp describe

Describe an environment Return a structured catalog of extensions, capabilities, and policies. Pass —env to load an environment module; otherwise use installed plugins.

Args

Flags

Examples

ecp discover

Discover ECP plugins on npm Search the npm registry for packages tagged ecosystem:ecp-plugin. First-party packages are marked; installed plugins are hidden unless —all.

Args

Flags

Examples

ecp init

Create a workflow file Write <name>.ecp.ts with a jsonata.transform step. Use ecp search to find capabilities.

Args

Examples

ecp install

Install plugins a workflow file requires Infer required plugins from the workflow file and install them without running the workflow.

Args

Flags

Examples

ecp invoke

Invoke a capability Call a registered capability by id without running a workflow. Prints an InvokeResult JSON document.

Args

Flags

Examples

ecp plugins build

Generate oclif files for a plugin Write generated package.json fields, dist/oclif.js, and oclif.manifest.json from the compiled definition.

Args

Examples

ecp plugins check

Fail if generated plugin files are stale Compare package.json, dist/oclif.js, and oclif.manifest.json to the compiled definition.

Args

Examples

ecp plugins new

Scaffold an ECP plugin Write src/index.ts and a minimal package.json. Then run ecp plugins build.

Args

Examples

ecp rollback

Remove user overrides of bundled plugins Uninstall user-installed plugins that shadow a bundled (core) plugin so the CLI copy is used again.

Examples

ecp run

Run a workflow file Compile (if needed) and execute a workflow. —env is an optional environment file overlay; omit it to use the process host.

Args

Flags

Examples

ecp runs

Inspect and continue workflow runs Subcommands: list, show, resume, rerun.

ecp runs list

List run journals Newest first. Filter with —status and —workflow.

Flags

Examples

ecp runs rerun

Rerun from a step using the current workflow file Restores steps before —from from the journal. Default —from is the first failed step. Default —to is the end.

Args

Flags

Examples

ecp runs resume

Resume a stopped or paused run Starts a new run from the journal cursor. —approve records an approval for the paused step.

Args

Flags

Examples

ecp runs show

Show a run journal Print run.json, or one step with —step.

Args

Flags

Examples

Search environment capabilities Fuzzy-match capabilities by id or label. Quote multi-word queries.

Args

Flags

Examples

ecp update

Update user-installed ECP plugins List user plugins with newer versions on npm and install them. Core (bundled) plugins are not updatable this way; reinstall the CLI instead.

Flags

Examples

ecp validate

Validate a workflow file Compile (if needed) and validate a workflow against the process host, an optional —env file, and the workflow’s bindings. Never installs plugins.

Args

Flags

Examples

Plugin commands

ecp adobe-firefly-services audio-video-avatars

Get available avatars Retrieves the list of all available avatars for the user’s enterprise. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly audio-video-avatars.

Flags

Examples

ecp adobe-firefly-services audio-video-cancel-render-job

Cancel a render job Aborts an in-flight render job. Returns 202 Accepted as soon as the cancellation has been accepted; subsequent calls to GET /v1/status/\{jobId} will report "status": "canceled" once the worker has fully stopped the underlying render. Applicable only to render jobs submitted via POST /v1/templates/render. This endpoint does not apply to Describe, Reframe, TLS, TTS, or Avatar jobs. Notes: - Cancellation is idempotent. - Once propagated to the worker, in-progress outputs are not uploaded to the destinations specified in the original render request. - For a short window after the PUT, the status endpoint may still report running; poll until it transitions to canceled. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly audio-video-cancel-render-job.

Flags

Examples

ecp adobe-firefly-services audio-video-dub

Dub audio or video Generate dubbed video or audio. A composited lip sync can also be added for video dubbing. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly audio-video-dub.

Flags

Examples

ecp adobe-firefly-services audio-video-dub-dub

Dub audio or video Generate dubbed video or audio. A composited lip sync can be added for video dubbing. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly audio-video-dub-dub.

Flags

Examples

ecp adobe-firefly-services audio-video-generate-avatar

Generate avatar video from text Generates an avatar video from a provided transcript or audio file. You can provide the transcript either as plain text or a pre-signed URL. The API is asynchronous, so the response will include a job ID and a status URL for tracking the running job. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly audio-video-generate-avatar.

Flags

Examples

ecp adobe-firefly-services audio-video-generate-reframed-video

Reframe video This endpoint enables you to reframe video using AI. Provide video input with a pre-signed URL to generate reframed video output. This API has more limited capabilities than the v2 endpoint, and may be deprecated soon. It’s recommended to use the v2 endpoint instead. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly audio-video-generate-reframed-video.

Flags

Examples

ecp adobe-firefly-services audio-video-generate-reframed-video-v2

Reframe video v2 This endpoint enables you to reframe the input media. You can provide a video input via a pre-signed URL to generate reframed output video. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly audio-video-generate-reframed-video-v2.

Flags

Examples

ecp adobe-firefly-services audio-video-generate-speech

Generate speech from text This endpoint generates speech from a transcript. You can provide the transcript either as plain text or a pre-signed URL. The response will include a job ID and a status URL for tracking the job. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly audio-video-generate-speech.

Flags

Examples

ecp adobe-firefly-services audio-video-get-presets

Fetch video rendering presets Returns a list of predefined social-first encoding presets for rendering outputs. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly audio-video-get-presets.

Flags

Examples

ecp adobe-firefly-services audio-video-job-result

Get the result for a job Provides the result for an async dub job. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly audio-video-job-result.

Flags

Examples

ecp adobe-firefly-services audio-video-job-result-v2

Get job result This endpoint retrieves the result of an asynchronous reframed job initiated using the job ID. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly audio-video-job-result-v2.

Flags

Examples

ecp adobe-firefly-services audio-video-list-render-jobs

List render jobs Returns a paginated list of template render jobs owned by the authenticated caller, optionally filtered by status and creation date. Applicable only to render jobs submitted via POST /v1/templates/render. Jobs from other API types (Describe, Reframe, TLS, TTS, Avatar) are not returned. Filter syntax (FIQL): - status==running — single status equality - status=in=(running,not_started) — status set membership - createdDate=ge=2026-05-01T00:00:00Z — absolute ISO 8601 lower bound - createdDate=ge=-P7D — relative ISO 8601 duration (last 7 days) - Combine with ; (AND): status==running;createdDate=ge=-P7D Default filter: all statuses, createdDate within the last 30 days. Retention: createdDate filter values must fall within the 30-day retention window. Pagination: follow paging.nextUrl until it is absent (last page). Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly audio-video-list-render-jobs.

Flags

Examples

ecp adobe-firefly-services audio-video-status

Get job status Provides the status and result of an asynchronous job. For Dynamic Graphics Render (DGR), returns the status of a Describe template or Render job. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly audio-video-status.

Flags

Examples

ecp adobe-firefly-services audio-video-template-describe

Describe template Analyzes a MOGRT (video template) file and returns a manifest of editable controls; fonts, images, audio, video and other supported values. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly audio-video-template-describe.

Flags

Examples

ecp adobe-firefly-services audio-video-template-render

Render template Renders one or more video variations by applying overrides and export presets. Submit up to 10 overrides per call for a subset of editable layers and get a pre-signed URL link to download the video file. For layers that are not editable, the system defaults are automatically applied at export. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly audio-video-template-render.

Flags

Examples

ecp adobe-firefly-services audio-video-transcribe

Transcribe media Generates transcripts and captions for the input audio or video in the source language or in a target language. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly audio-video-transcribe.

Flags

Examples

ecp adobe-firefly-services audio-video-transcribe-transcribe

Transcribe media Generates transcripts for the input audio or video. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly audio-video-transcribe-transcribe.

Flags

Examples

ecp adobe-firefly-services audio-video-voices

Get available voices This endpoint provides the list of all available voices for the user’s enterprise. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly audio-video-voices.

Flags

Examples

ecp adobe-firefly-services creative-production-batch-execute

Execute a batch of assets through a workflow Start a new batch job to process multiple assets through a published workflow. The request body supplies the workflow identifier and inputs: a list of runs, where each run is an array of node input mappings (node_id plus content and/or template). Each run is processed separately through the workflow in parallel. Returns a batchId and links that can be used to track progress and retrieve results. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly creative-production-batch-execute.

Flags

Examples

ecp adobe-firefly-services creative-production-cancel-batch

Cancel a batch Cancel a batch job that is currently pending or running. Once cancelled, no new assets will be processed. Assets currently being processed may complete. The batch status will be updated to ‘cancelled’. Cannot cancel batches that are already completed, failed, or cancelled. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly creative-production-cancel-batch.

Flags

Examples

ecp adobe-firefly-services creative-production-get-batch-status

Get batch status Get the current status and progress of a batch job. Returns the batch identifier, workflow identifier, status, asset and execution counters (including execution IDs), timestamps, and hypermedia links to cancel or list executions. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly creative-production-get-batch-status.

Flags

Examples

ecp adobe-firefly-services creative-production-list-batch-executions

List individual execution results List all individual asset execution results within a batch, with optional filtering. Returns detailed results for each asset including: - Execution status (pending, running, success, failed) - Input asset data - Output results (if successful) - Error messages (if failed) - Timing information The response supports pagination and filtering by execution status. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly creative-production-list-batch-executions.

Flags

Examples

ecp adobe-firefly-services creative-production-list-batches

List batches List all batches created by the authenticated user within their organization. Results are automatically filtered by the authenticated user’s ID. Users can only view their own batches, not batches created by other users in the organization. Results are sorted by creation date (most recent first) and include pagination metadata. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly creative-production-list-batches.

Flags

Examples

ecp adobe-firefly-services express-export-rendition

Export rendition Export one or more pages from an Adobe Express document in supported formats. This endpoint accepts an export request and returns pre-signed URLs for accessing the rendered files. Supported formats: - Image formats: image/jpeg (JPG), image/png (PNG) - Video format: video/mp4 (MP4) - Document format: application/pdf (PDF) Rendition availability: - Image renditions: Valid for 4 hours, maximum size 8192px on the longest side - Video and PDF renditions: Valid for 24 hours, maximum size 4096px on the longest side Asynchronous processing: Export requests are processed asynchronously. The response includes a jobId and statusUrl that you can use to track the export progress and retrieve the final rendition URLs. Restrictions: | Condition | Behavior | Error | | --- | --- | --- | | Public templates (Adobe-owned documents not copied to the user account) | Export is not allowed | 400 bad_request | | Document contains Adobe Stock–licensed assets | Export fails | 422 stock_content_detected | Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly express-export-rendition.

Flags

Examples

ecp adobe-firefly-services express-generate-variation

Generate variation This API creates a document variation based on provided input parameters. After processing, it temporarily stores the generated document and makes it available to the user within a designated folder. The document remains accessible for 30 days, after which the system automatically removes it. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly express-generate-variation.

Flags

Examples

ecp adobe-firefly-services express-get-job-status

Job status Retrieve a job’s status by its jobId. Depending on the job type, the response may include job-specific details. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly express-get-job-status.

Flags

Examples

ecp adobe-firefly-services express-tagged-document-details

Tagged document details This API retrieves details of the pages and tagged elements within a specified document. It returns a paginated list of the document’s pages and metadata about each page. If the document has tagged elements, the API includes their respective details, such as size and position. If the document does not have tagged elements, it returns an empty array. The response includes pagination information to help users navigate the document’s pages. A maximum of 10 pages can be returned in 1 API call. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly express-tagged-document-details.

Flags

Examples

ecp adobe-firefly-services express-tagged-documents

Tagged documents This API retrieves a list of tagged documents that users can access, including those they own or those shared with them, along with relevant metadata. It supports pagination and sorting, allowing users to specify the starting point, define the number of documents to return, and choose the order in which to list them. The response includes the requested documents and their metadata. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly express-tagged-documents.

Flags

Examples

ecp adobe-firefly-services firefly-adaptive-composite

Generate adaptive composite Submits an asynchronous adaptive composite generation job using the adaptive composite pipeline. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly firefly-adaptive-composite.

Flags

Examples

ecp adobe-firefly-services firefly-cancel-job-v4

Cancel job Cancel an asynchronous job. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly firefly-cancel-job-v4.

Flags

Examples

ecp adobe-firefly-services firefly-expand-images-v3-async

Expand image Change the aspect ratio or size of an image to expand it. Optionally, provide a text prompt to generate additional imagery for the expansion. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly firefly-expand-images-v3-async.

Flags

Examples

ecp adobe-firefly-services firefly-fill-images-v3-async

Fill image Generates a fill in an area of an image based on a text prompt. A mask defines the area of the image to be filled. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly firefly-fill-images-v3-async.

Flags

Examples

ecp adobe-firefly-services firefly-generate-images-v3-async

Generate images Generate images based on a text prompt. You may also include a reference image and Firefly will try to mimic the characteristics, such as color scheme, lighting, layout of objects in the image, etc. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly firefly-generate-images-v3-async.

Flags

Examples

ecp adobe-firefly-services firefly-generate-images-v5-async

Generate images with Image5 Generate images asynchronously using Firefly’s Image5 model. When referenceBlobs is included in the request, omit aspectRatio or set it to auto. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly firefly-generate-images-v5-async.

Flags

Examples

ecp adobe-firefly-services firefly-generate-object-composite-v3-async

Generate object composite Combines your image and images generated by Firefly to create an image composite, or scene. The images that Firefly generates are based on a text prompt that you provide. You can upload an image with or without an image mask, such as a product photo, but for a successful result one of the following conditions must be true: The request size is larger than the input image, OR The image contains a transparent layer/channel, OR A mask is provided Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly firefly-generate-object-composite-v3-async.

Flags

Examples

ecp adobe-firefly-services firefly-generate-similar-images-v3-async

Generate similar images Generate similar images based on a reference image that you provide as a parameter. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly firefly-generate-similar-images-v3-async.

Flags

Examples

ecp adobe-firefly-services firefly-generate-video-v3

Generate video Generate a five second video using a text prompt. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly firefly-generate-video-v3.

Flags

Examples

ecp adobe-firefly-services firefly-get-custom-models

Retrieve custom models Retrieve the custom models for a user. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly firefly-get-custom-models.

Flags

Examples

ecp adobe-firefly-services firefly-job-result-v3

Get job status Get the status of an asynchronous job (including upscale jobs). When the job has completed successfully, the result reflects the operation type (for example generation, composite, or upscale). Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly firefly-job-result-v3.

Flags

Examples

ecp adobe-firefly-services firefly-precise-composite

Generate precise composite Submits an asynchronous precise composite generation job using the precise composite pipeline. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly firefly-precise-composite.

Flags

Examples

ecp adobe-firefly-services firefly-precise-upsampler-v3-async

Upscale image Upscales an image asynchronously using the precise upsampler. Provide the input image via an upload ID from the storage API or a presigned URL. The response includes links to check status and retrieve the result. Poll the status URL until the job completes, then fetch the result for the upscaled image(s). Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly firefly-precise-upsampler-v3-async.

Flags

Examples

ecp adobe-firefly-services firefly-storage-image-v2

Upload image Upload source image or mask for image-to-image operations, such as fill, expand, or upscale. This API returns an identifier that is used to refer to uploaded content. The uploaded assets will be valid for 7 days from the date you upload them. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly firefly-storage-image-v2.

Flags

Examples

ecp adobe-firefly-services illustrator-create-rendition

Create rendition This endpoint allows you to convert Adobe Illustrator files into various output formats. It supports conversion of .ai documents into multiple web- and print-ready formats. The request is processed asynchronously and the status of the job can be checked using the status URL provided in the response. The output is provided as a single converted file. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly illustrator-create-rendition.

Flags

Examples

ecp adobe-firefly-services illustrator-custom-scripts-job-status

Retrieve job status Poll execution status for a Custom Scripts job. Use this after calling custom script execute. When the job succeeds, each entry in outputs includes a presigned URL to download an output file. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly illustrator-custom-scripts-job-status.

Flags

Examples

ecp adobe-firefly-services illustrator-data-merge

Data merge This endpoint allows you to merge variable data from a CSV file with an Adobe Illustrator template. The request is processed asynchronously and the status of the job can be checked using the status URL provided in the response. The output is provided as an array of individual files, one for each row in the CSV data. If some rows succeed and others fail or require rerun, the job completes with status partially_succeeded when you poll the status endpoint; that status applies only to Data Merge jobs. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly illustrator-data-merge.

Flags

Examples

ecp adobe-firefly-services illustrator-execute-custom-script-capability

Submit a custom script execution request Submits execution requests for custom scripts. Defines input assets and parameters that the custom script will use during execution. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly illustrator-execute-custom-script-capability.

Flags

Examples

ecp adobe-firefly-services illustrator-facade-job-status

Retrieve job status Retrieve the status of a job by providing the job ID. The job ID can be obtained from the response of other APIs. For all asynchronous jobs, polling this endpoint can return running, succeeded, or failed. The partially_succeeded status is returned only for Data Merge jobs when some CSV rows produce outputs while other rows fail or must be rerun after errors (for example, missing fonts). No other job types return the partially_succeeded status.When status is succeeded, for Data Merge jobs each item in outputs includes a row field; for Create Rendition jobs, output items contain destination and mediaType only. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly illustrator-facade-job-status.

Flags

Examples

ecp adobe-firefly-services illustrator-image-trace-job-status

Retrieve job status Poll execution status for an Image Trace job. Use this after calling Image Trace. Poll GET /v1/status/\{jobId} with the job ID from the trace-image response. When the job succeeds, each output item includes a presigned URL and SVG media type (image/svg+xml). Image Trace jobs return only running, succeeded, or failed. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly illustrator-image-trace-job-status.

Flags

Examples

ecp adobe-firefly-services illustrator-register-custom-script-capability

Submit a Custom Script Submits Custom Script bundles for registration. Returns a URL for posting execution requests for the registered script. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly illustrator-register-custom-script-capability.

Flags

Examples

ecp adobe-firefly-services illustrator-trace-image

Submit a job This endpoint allows you to convert a raster image (JPEG/PNG) into vector format (SVG). The request is processed asynchronously and the status of the job can be checked using the status URL provided in the response. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly illustrator-trace-image.

Flags

Examples

ecp adobe-firefly-services indesign-convert-pdfto-in-design

Convert PDF to InDesign document Converts PDF documents to editable InDesign (INDD or IDML) format. The output is a ZIP file (default name ‘output.zip’) containing subfolders (named after each input PDF) with the converted document and associated assets. If embedLinks is false, assets are provided in a separate folder within the ZIP. If embedLinks is true, all links are embedded in the InDesign file. Returns warnings for missing fonts and links. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly indesign-convert-pdfto-in-design.

Flags

Examples

ecp adobe-firefly-services indesign-data-merge

Perform a data merge Creates InDesign documents or PDFs by merging CSV data with InDesign templates. Supports multiple output formats: JPEG (image/jpeg), PNG (image/png), PDF (application/pdf), and InDesign (application/x-indesign). Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly indesign-data-merge.

Flags

Examples

ecp adobe-firefly-services indesign-data-merge-tags

Get data merge tags Retrieves the data merge tags from a document. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly indesign-data-merge-tags.

Flags

Examples

ecp adobe-firefly-services indesign-delete-custom-script

Delete a Custom Script Deletes a single registered custom script. All versions of the script will be permanently removed. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly indesign-delete-custom-script.

Flags

Examples

ecp adobe-firefly-services indesign-execute-custom-script

Submit a custom script execution request Submits execution requests for custom scripts. Defines input assets and parameters that the custom script will use during execution. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly indesign-execute-custom-script.

Flags

Examples

ecp adobe-firefly-services indesign-get-convert-pdfto-in-design-job-status

Get status - Convert PDF to InDesign API Returns the latest status of a job, in this case a PDF to InDesign conversion job. Poll this endpoint to retrieve the job results, warnings, and download URL of the output, in this case an output ZIP file. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly indesign-get-convert-pdfto-in-design-job-status.

Flags

Examples

ecp adobe-firefly-services indesign-get-custom-script-details

Get Custom Script details Retrieves details of a single registered custom script. Includes version, download link, registration date, and script name. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly indesign-get-custom-script-details.

Flags

Examples

ecp adobe-firefly-services indesign-get-document-info

Get document information Retrieve comprehensive information about INDD/IDML documents. Returns data based on the enabled information types specified in the request. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly indesign-get-document-info.

Flags

Examples

ecp adobe-firefly-services indesign-get-document-info-job-status

Get status - Document Info API Returns the latest status of a Document Info job. Poll this endpoint to retrieve the extracted document information including pages, links, fonts, page items, and text stories. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly indesign-get-document-info-job-status.

Flags

Examples

ecp adobe-firefly-services indesign-get-job-status

Get the status of a job Returns the latest status of an executed custom script job. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly indesign-get-job-status.

Flags

Examples

ecp adobe-firefly-services indesign-list-app-versions

Get Current App Versions Retrieves information about all available InDesign app versions. Returns major version, minor version, and status for each registered app version. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly indesign-list-app-versions.

Flags

Examples

ecp adobe-firefly-services indesign-list-custom-scripts

List custom scripts API Retrieves details of the latest version of all registered custom scripts. Includes version, download link, registration date, and script name. Response is paginated based on list length. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly indesign-list-custom-scripts.

Flags

Examples

Remap links Replaces file-based links in InDesign documents with AEM URLs. Particularly useful for customers working with Adobe Experience Manager (AEM) using Adobe Asset Link, enabling designers to work with output files that have direct links to AEM URLs. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly indesign-remap-links.

Flags

Examples

ecp adobe-firefly-services indesign-rendition-job

Create JPEG, PNG, or PDF renditions Creates JPEG, PNG, or PDF renditions of InDesign documents. Supports multiple output formats: JPEG (image/jpeg), PNG (image/png), and PDF (application/pdf). Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly indesign-rendition-job.

Flags

Examples

ecp adobe-firefly-services indesign-submit-custom-script

Submit a Custom Script Submits custom script bundles for registration. Returns a URL for posting execution requests for the registered script. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly indesign-submit-custom-script.

Flags

Examples

ecp adobe-firefly-services indesign-update-script-app-version

Update Custom Script App Version Updates the InDesign app version configuration for a registered custom script. Allows customers to specify version strategies: use latest version, fix to a major version, or fix to a specific major and minor version. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly indesign-update-script-app-version.

Flags

Examples

ecp adobe-firefly-services photoshop-auto-crop

Auto crop Generates smart crops, subject bounding boxes, and detects objects for an input image. The request is processed asynchronously. Poll GET /v2/status/{jobId} with the returned jobId for completion. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly photoshop-auto-crop.

Flags

Examples

ecp adobe-firefly-services photoshop-create-artboard

Create an artboard Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly photoshop-create-artboard.

Flags

Examples

ecp adobe-firefly-services photoshop-create-composite

Create or edit a composite Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly photoshop-create-composite.

Flags

Examples

ecp adobe-firefly-services photoshop-edit

Edit an image with various adjustments Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly photoshop-edit.

Flags

Examples

ecp adobe-firefly-services photoshop-execute-actions

Execute Photoshop actions, scripts, and transformations Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly photoshop-execute-actions.

Flags

Examples

ecp adobe-firefly-services photoshop-generate-manifest

Generate a manifest for given input image Call this while authoring when the user has a Photoshop file and the next steps depend on its layers or size. The output can be large. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly photoshop-generate-manifest.

Flags

Examples

ecp adobe-firefly-services photoshop-get-job-status

Get Job Status Retrieves the current status and details of a specific job including metadata, outputs, and processing information. Use this endpoint to poll jobs submitted to Photoshop v2 operations and POST /v1/auto-crop. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly photoshop-get-job-status.

Flags

Examples

ecp adobe-firefly-services substance3d-create-space-from-frame-io-v2

Create Space From Frame IO API

Overview The Substance 3D API provides a way to upload and temporary store files. You can upload folders from frame.io to create a space. To upload a folder from frame.io, you must pass the following parameters: - access Token - folder ID The result of the post is a JSON which contained the id of the space created. Space id can be used into a space source to use space content as a source for API operations. Example of a space source: json \{ "space": \{ "id": "" } }

Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly substance3d-create-space-from-frame-io-v2.

Flags

Examples

ecp adobe-firefly-services substance3d-create-space-from-next-frame-io-v2

Create Space From Next Frame IO API

Overview The Substance 3D API provides a way to upload and temporary store files. You can upload folders from next.frame.io to create a space. To upload a folder from next.frame.io, you must pass the following parameters: - access Token - account ID - folder ID The result of the post is a JSON which contained the id of the space created. Space id can be used into a space source to use space content as a source for API operations. Example of a space source: json \{ "space": \{ "id": "" } }

Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly substance3d-create-space-from-next-frame-io-v2.

Flags

Examples

ecp adobe-firefly-services substance3d-create-space-url-v2

Create Space from URL API

Overview The Substance 3D API provides a way to upload and temporary store files. You can upload one or more files from one or more URLs. For each URL, there is an optional filepath parameter that allows you to specify the file name and its path. By combining multiple URLs with different filepath paths, you can compose a complete file tree structure. Example for this files tree: ├── textures │ ├── diffuse.png │ └── normal.png └── lighthouse.fbx Curl request: curl --request POST \ --url https://s3d.adobe.io/v2/spacesURL \ --header 'Accept: application/json' \ --header 'Authorization: Bearer 123' \ --header 'Content-Type: application/json' \ --data '[ \{ "filepath": "lighthouse.fbx", "url": "https://url/to/lighthouse.fbx" }, \{ "filepath": "textures/diffuse.png", "url": "https://url/to/diffuse.png" }, \{ "filepath": "textures/normal.png", "url": "https://url/to/normal.png" } ]' The result of the post is a JSON which contained the id of the space created. Space id can be used into a space source to use space content as a source for API operations. Example of a space source: json \{ "space": \{ "id": "" } }

Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly substance3d-create-space-url-v2.

Flags

Examples

ecp adobe-firefly-services substance3d-create-space-v1

Create Space Create a Space from 3D files. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly substance3d-create-space-v1.

Flags

Examples

ecp adobe-firefly-services substance3d-create-space-v2

Create Space API

Overview The Substance 3D API provides a way to upload and temporarily store files. Uploading files requires a multipart/form-data request to send data. The request requires a files field containing a list of files. Each file’s filename field can contain a filepath to specify where the file will be stored in the space. Example for this files tree: ├── textures │ ├── diffuse.png │ └── normal.png └── lighthouse.fbx HTTP data relative to the previous files tree: HTTP POST /spaces HTTP/1.1 Host: localhost:8080 Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW ------WebKitFormBoundary7MA4YWxkTrZu0gW Content-Disposition: form-data; name="files"; filename="lighthouse.fbx" Content-Type: model/vnd.autodesk.fbx (data) ------WebKitFormBoundary7MA4YWxkTrZu0gW Content-Disposition: form-data; name="files"; filename="textures/diffuse.png" Content-Type: image/png (data) ------WebKitFormBoundary7MA4YWxkTrZu0gW Content-Disposition: form-data; name="files"; filename="textures/normal.png" Content-Type: image/png (data) ------WebKitFormBoundary7MA4YWxkTrZu0gW-- Curl command to create this file tree: curl -X POST https://s3d.adobe.io/v2/spaces \ -F "files=@Local/Path/To/The/Local/File/lighthouse.fbx;filename=lighthouse.fbx" \ -F "files=@Local/Path/To/The/Local/File/diffuse.png;filename=textures/diffuse.png" \ -F "files=@Local/Path/To/The/Local/File/normal.png;filename=textures/normal.png" The result of the post is a JSON which contained the id of the space created. Space id can be used into a space source to use space content as a source for API operations. Example of a space source: json \{ "space": \{ "id": "" } }

Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly substance3d-create-space-v2.

Flags

Examples

ecp adobe-firefly-services substance3d-v1-composites-compose

Generate 3D object composite Generate a 3D Object Composite with the Substance 3D API. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly substance3d-v1-composites-compose.

Flags

Examples

ecp adobe-firefly-services substance3d-v1-scenes-assemble

Create 3D scene Assemble a 3D scene with the Substance 3D API. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly substance3d-v1-scenes-assemble.

Flags

Examples

ecp adobe-firefly-services substance3d-v1-scenes-convert

Convert 3D files Convert a 3D file into another 3D format with the Substance 3D API. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly substance3d-v1-scenes-convert.

Flags

Examples

ecp adobe-firefly-services substance3d-v1-scenes-describe

Describe 3D scene Describe a 3D scene. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly substance3d-v1-scenes-describe.

Flags

Examples

ecp adobe-firefly-services substance3d-v1-scenes-render

Render 3D object Render a 3D object with the Substance 3D API. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly substance3d-v1-scenes-render.

Flags

Examples

ecp adobe-firefly-services substance3d-v1-scenes-render-basic

Render 3D object (basic version) Render a 3D object (basic version) with the Substance 3D API. Plugin: @executioncontrolprotocol/plugin-adobe-firefly-services. Aliases: ecp firefly substance3d-v1-scenes-render-basic.

Flags

Examples

ecp anthropic generate

Generate text with multimodal Anthropic Messages. Runs chat completion against the Anthropic Messages API. Accepts images and documents on the final user turn in browser and Node hosts. Requires a configured API key. Supports system prompts, prior turns, and sampling options. Plugin: @executioncontrolprotocol/plugin-anthropic.

Flags

Examples

ecp app

Open a live graph of a workflow file Serve the App on 127.0.0.1 with a pairing token in the URL. File edits update the graph; graph edits rewrite the file. Runs use the same host and journal as ecp run. The App stores no secrets. Until 0.50.0 is on the registry, install with ecp plugins link plugins/plugin-app. Plugin: @executioncontrolprotocol/plugin-app.

Args

Flags

ecp azure-blob-storage create-sas-url

Mint a time-limited SAS URL for a blob Generates a shared-access signature URL with chosen read, write, or delete permissions and expiry for an existing blob in a container. Plugin: @executioncontrolprotocol/plugin-azure-blob-storage.

Flags

Examples

ecp azure-blob-storage download

Download a blob into a workflow artifact Fetches blob bytes from Azure Storage and stores them as a media artifact with content type and name for local processing. Plugin: @executioncontrolprotocol/plugin-azure-blob-storage.

Flags

Examples

ecp azure-blob-storage upload

Upload bytes or a file reference to a blob Writes content to a named blob in a container from a base64 payload, local path, artifact locator, or browser file reference. Returns the blob location and optional SAS URL. Plugin: @executioncontrolprotocol/plugin-azure-blob-storage.

Flags

Examples

ecp fal generate

Run a FAL model endpoint with a model-specific payload Invokes a FAL-hosted model by endpoint id using either a direct run or a subscribe flow that polls until completion. Returns the model result payload and optional request id. Plugin: @executioncontrolprotocol/plugin-fal.

Flags

Examples

ecp format-mermaid encode

Render a workflow manifest as a Mermaid graph. Produces Mermaid flowchart text from a workflow manifest. Validates the source workflow first and returns diagnostics when invalid. Supports layout options via encode options. Plugin: @executioncontrolprotocol/plugin-format-mermaid.

Flags

Examples

ecp format-toon decode

Parse TOON text into an ECP document. Decodes TOON input into the requested target document. Validates the result and returns diagnostics when parsing or schema checks fail. Plugin: @executioncontrolprotocol/plugin-format-toon.

Flags

Examples

ecp format-toon encode

Serialize an ECP document to TOON text. Encodes a supported source into TOON for compact interchange or CLI export. Honors encode options such as headers and compact layout. Plugin: @executioncontrolprotocol/plugin-format-toon.

Flags

Examples

ecp image-sharp composite

Layer overlay images onto a base image Composites one or more overlay images onto a base image with optional position, gravity, blend mode, and tiling. Plugin: @executioncontrolprotocol/plugin-image-sharp.

Flags

Examples

ecp image-sharp convert

Convert an image to another format Re-encodes a source image to the requested output format and quality without additional geometric transforms. Plugin: @executioncontrolprotocol/plugin-image-sharp.

Flags

Examples

ecp image-sharp crop

Crop a rectangular region from an image Extracts a box defined by left, top, width, and height from the source image and returns the cropped result as a new artifact. Plugin: @executioncontrolprotocol/plugin-image-sharp.

Flags

Examples

ecp image-sharp derive

Produce multiple named variants from one source Runs independent pipelines for each named variant against the same source image and returns all outputs in one result object. Plugin: @executioncontrolprotocol/plugin-image-sharp.

Flags

Examples

ecp image-sharp inspect

Inspect image format, dimensions, and optional stats Reads an image from a path, URL, artifact, or buffer and returns format metadata, dimensions, orientation, and optional channel statistics without modifying pixels. Plugin: @executioncontrolprotocol/plugin-image-sharp.

Flags

Examples

ecp image-sharp metadata

Read EXIF and embedded image metadata Returns embedded metadata such as EXIF tags, density, and orientation for a single image without running a full inspect or transform pipeline. Plugin: @executioncontrolprotocol/plugin-image-sharp.

Flags

Examples

ecp image-sharp normalize

Auto-orient, convert to sRGB, and strip metadata Applies auto-rotation from EXIF orientation, converts colors to sRGB, and removes embedded metadata for web-safe, consistent output. Plugin: @executioncontrolprotocol/plugin-image-sharp.

Flags

Examples

ecp image-sharp resize

Resize an image to target dimensions Scales an image to requested width and height using fit modes such as cover, contain, or inside, with optional enlargement guards and kernel selection. Plugin: @executioncontrolprotocol/plugin-image-sharp.

Flags

Examples

ecp image-sharp stats

Compute channel statistics for an image Calculates per-channel min, max, mean, and related stats for an image, useful for exposure checks and automated quality gates. Plugin: @executioncontrolprotocol/plugin-image-sharp.

Flags

Examples

ecp image-sharp thumbnail

Generate multiple named thumbnail sizes Builds a map of named thumbnails from one source image, each resized with a shared fit mode and output settings. Plugin: @executioncontrolprotocol/plugin-image-sharp.

Flags

Examples

ecp image-sharp transform

Run a declarative Sharp pipeline on one image Applies an ordered list of resize, crop, rotate, blur, tint, composite, and other Sharp operations, then writes the result as an artifact with chosen format and quality. Plugin: @executioncontrolprotocol/plugin-image-sharp.

Flags

Examples

ecp jsonata transform

Evaluate a JSONata expression on a JSON payload Compiles and runs a JSONata expression against the provided payload with optional variable bindings, returning the evaluated result. Use after inspect or fetch when the raw object is too large for chat or later steps. Plugin: @executioncontrolprotocol/plugin-jsonata.

Flags

Examples

ecp ollama generate

Generate text via a local Ollama server. Runs chat completion against an Ollama instance on the configured base URL. Suited for local development and offline Node workloads. Does not accept file attachments yet. Override the model per call or set a default in extension config. Plugin: @executioncontrolprotocol/plugin-ollama.

Flags

Examples

ecp ollama listModels

List models available on the Ollama server. Returns model tags reported by the Ollama tags API. Use before generate to pick an installed model or to populate a model picker in local dev tools. Plugin: @executioncontrolprotocol/plugin-ollama.

Flags

Examples

ecp openai generate

Generate text via a hosted cloud chat API. Runs chat completion against a remote model endpoint. Suited for production Node workloads that need widely available frontier models. Requires a configured API key. Does not accept file attachments yet. Plugin: @executioncontrolprotocol/plugin-openai.

Flags

Examples

Next steps