@axway/amplify-ace-cli

@axway/amplify-ace-cli

CLI package for the Axway AMPLIFY ACE CLI.

Installation

Assuming you are familiar with Node.js and npm, you should first install the Axway AMPLIFY CLI, which will give you connectivity to the Axway AMPLIFY Platform. Note that you must first have an account on https://platform.axway.com, and be provisioned in API Central:

$ [sudo] npm install -g @axway/amplify-cli

Use the AMPLIFY package manager command to install the ACE CLI:

$ amplify pm install @axway/amplify-ace-cli

Getting started

Log in to the [Axway AMPLIFY Platform] using the following command:

$ amplify auth login

See available login and auth options using the command:
$ amplify auth login -h

Log out of the [Axway AMPLIFY Platform] using the following command:

$ amplify auth logout

See available logout and auth options using the command:
$ amplify auth logout -h

CLI reference

Usage

NOTE: All CIL commands require authentication. You must be logged in to the Axway AMPLIFY Platform (see above) or the commands will fail.

$ amplify ace <command> [options]

Commands:
  init  Initialize ACE project
  step  Step configuration management
  choreography  Choreography configuration management
  serviceaccount  Service account configuration management
  webhookclient  Webhook event client configuration management

Commands

amplify ace init [sub-command]

Initialize a new ACE project using GoLang, Java, or NodeJS

Examples

Begin the ACE project initialization wizard:

$ amplify ace init

amplify ace step [sub-command]

Step configuration management

Sub-command

list - List all registered steps. Note that amplify ace step and amplify ace step list are currently the same command.

Examples

Display all registered steps:

$ amplify ace step   (or amplify ace step list)

amplify ace choreography [sub-command][--options]

Choreography configuration management

Sub-command

add - Add a choreography

Options

--f=<filePath> - path to a JSON file containing the choreography to add (required). The JSON file must be formatted correctly and adhere to the rules for a valid choreography layout.

Sub-command

delete - Delete a choreography

Options

--id=<id> - id of the choreography to delete (delete: required)

Sub-command

list - List the choreographies

Options

--id=<id> - id of the choreography to display (list: optional)

--name=<name> - name of the choreography(s) to display (list: optional)

Sub-command

run - Run a choreography

Options

--f=<filePath> - path to a file containing payload to attach to message (run: optional)

--ref=<filePath> - path to a reference to a file containing a payload to attach to the message (run: optional)

Examples

Add a choreography:

$ amplify ace choreography add --f=./path/choreo.json

Delete a choreography:

$ amplify ace choreography delete --id=73296

Display all registered choreographies:

$ amplify ace choreography

Display the details of a specific choreography:

$ amplify ace choreography list --id=736326

or

$ amplify ace choreography list --name=MyChoreography

Run a choreography:

$ amplify ace choreography run choreoName --f=./path/xxx.yy

or

$ amplify ace choreography run choreoName --ref=./path/xxx.yy

amplify ace serviceaccount [sub-command][--options]

Service account configuration management

Sub-command

add <name> - Add a service account (<name> is required)

Sub-command

delete - Delete a service account

Options

--id=<id> - id of the service account to delete (delete: required)

Sub-command

list - List the service accounts

Options

--id=<id> - id of the service account to display (list: optional)

Examples

Add a service account:

$ amplify ace serviceaccount add <name>

Delete a service account:

$ amplify ace serviceaccount delete --id=73296

Display all service accounts:

$ amplify ace serviceaccount
or
$ amplify ace serviceaccount list

Display the details of a specific service account:

$ amplify ace serviceaccount list --id=736326
or
$ amplify ace serviceaccount --id=736326

amplify ace webhookclient [sub-command][--options]

Webhook event client configuration management

Sub-command

add - Add a webhook event client

Sub-command

delete - Delete a webhook event client

Options

--id=<id> - id of the webhook event client to delete (delete: required)

Sub-command

list - List the webhook event clients

Options

--id=<id> - id of the webhook event client to display (list: optional)

Sub-command

update - Update a specific webhook event client

Examples

Add a webhook event client:

$ amplify ace webhookclient add

Delete a webhook event client:

$ amplify ace webhookclient delete --id=73296

Display all webhook event clients:

$ amplify ace webhookclient
or
$ amplify ace webhookclient list

Display the details of a specific service account:

$ amplify ace webhookclient list --id=736326
or
$ amplify ace webhookclient --id=736326

Update a specific service account:

$ amplify ace webhookclient update

Author

Axway [e-mail] https://www.axway.com

License

This code is closed source and Confidential and Proprietary to Axway, Inc. All Rights Reserved. This code MUST not be modified, copied or otherwise redistributed without express written permission of Axway. This file is licensed as part of the Axway Platform and governed under the terms of the Axway license agreement. Your right to use this software terminates when you terminate your Axway subscription. Please read the LICENSE file included in this distribution for more information.