Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Excerpt Include
Amplify CLI
Amplify CLI
nopaneltrue


The quick start includes details on installing the Amplify CLI and the Amplify CLI components.

Installation

To install the Amplify CLI, run the following from the terminal:

Code Block
languagebash
npm i -g @axway/amplify-cli

Some Linux and macOS systems require elevated filesystem access to install the Amplify CLI in the global location and require npm to be run as sudo:

Code Block
languagebash
sudo npm i -g @axway/amplify-cli

Getting help

The Amplify CLI has built-in help that can be accessed by passing --help into any command or by running:

Code Block
languagebash
amplify

Proxy server configuration

If you you are behind a network proxy server, then you may need to set the proxy server URL by running the following command and replacing the username, password, proxy server URL, and port number.

Code Block
languagebash
amplify config set network.httpProxy http://<username>:<password>@<proxy-server-url>:<port>

You will also need to configure the proxy server for npm:

Code Block
languagebash
npm config set https-proxy http://<username>:<password>@<proxy-server-url>:<port>

For more information, visit the configuration page.

Proxy server with self-signed certificate

If your proxy server uses a self-signed TLS/SSL certificate, then you will need to disable certificate validation:

Code Block
languagebash
# Linux/macOS
export NODE_TLS_REJECT_UNAUTHORIZED=0

# Windows
set NODE_TLS_REJECT_UNAUTHORIZED 0

Also, disable the certificate for npm:

Code Block
languagebash
npm config set strict-ssl false

Authentication

To log into the Amplify Platform, run:

Code Block
languagebash
amplify auth login

For more information, visit the authentication page.

Packages

The Amplify CLI package manager allows you to search, view, install, update, and uninstall packages such as other Axway CLI products.

To search for an Amplify package, run:

Code Block
languagebash
amplify pm search

To install a package, run:

Code Block
languagebash
amplify pm install <package>[@<version>]

To list installed packages, run:

Code Block
languagebash
amplify pm list