Package Exports

@adobe/aio-cli-plugin-asset-compute

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@adobe/aio-cli-plugin-asset-compute) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@adobe/aio-cli-plugin-asset-compute

Asset Compute Plugin for Adobe I/O Command Line Interface

Installation and Usage

This can be installed & used in three ways:

aio plugin
local devDependency
global standalone cli

Install as aio plugin

This requires aio-cli.

aio plugins:install @adobe/aio-cli-plugin-asset-compute

It provides the asset-compute command topic. You can run e.g. the test command using:

aio asset-compute test-worker

Help and available commands can be seen with:

aio asset-compute

Install as local devDependency

Install into your devDependencies:

npm install --save-dev @adobe/aio-cli-plugin-asset-compute

Then use in npm scripts in your package.json, for example for tests:

   "scripts": {
       "test": "adobe-asset-compute test-worker"
   }

Use npx if you want to manually run it. Inside your project run for example:

npx adobe-asset-compute run-worker

Help and available commands can be seen with:

npx adobe-asset-compute

Install as global standalone cli

Install globally using:

npm install -g @adobe/aio-cli-plugin-asset-compute

This will add the adobe-asset-compute cli to your system. Run using:

adobe-asset-compute test-worker

Help and available commands can be seen with:

adobe-asset-compute

Commands

adobe-asset-compute devtool
adobe-asset-compute run-worker FILE RENDITION
adobe-asset-compute test-worker [TESTCASE]

`adobe-asset-compute devtool`

Runs the Asset Compute Developer Tool UI

USAGE
  $ adobe-asset-compute devtool

OPTIONS
  -v, --verbose  Verbose output
  --port=port    [default: 9000] Http port of the Asset Compute Developer Tool Server
  --version      Show version

`adobe-asset-compute run-worker FILE RENDITION`

Run worker from local project using Docker

USAGE
  $ adobe-asset-compute run-worker FILE RENDITION

ARGUMENTS
  FILE       Path to input file for worker

  RENDITION  Path where to create output rendition.
             Single file for single rendition, or directory to create multiple renditions, in which case the full
             parameter json including rendition names must be provided using --data.

OPTIONS
  -P, --paramFile=paramFile  Path to parameter json file.
  -a, --action=action        Worker to run. Use action name from manifest. Not required if there is only one.
  -d, --data=data            Complete input parameters as JSON string. Allows multiple renditions.
  -p, --param=param          <key> <value> - Set parameters for rendition, can be used multiple times
  -v, --verbose              Verbose output
  --version                  Show version

`adobe-asset-compute test-worker [TESTCASE]`

Run tests from local project

USAGE
  $ adobe-asset-compute test-worker [TESTCASE]

ARGUMENTS
  TESTCASE  Test case(s) to run. Supports glob patterns. If not set, runs all tests.

OPTIONS
  -a, --action=action     Worker to test. Use action name from manifest. If not set, runs tests for all workers.
  -u, --updateRenditions  Replace expected renditions of failing test cases with the generated rendition.
  -v, --verbose           Verbose output
  --version               Show version

ALIASES
  $ adobe-asset-compute tw

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.