Skip to end of metadata
Go to start of metadata

Icon

Thank you for your interest in the Amplify CLI. This documentation covers the Amplify CLI up to version 1.5.x.

As always we seek to provide the best solutions possible to help you achieve your business needs. We recommend trying out the Axway CLI, which replaces the Amplify CLI and provides a richer feature set with a more robust experience. Check out the Axway CLI documentation for more information on how to download and try it out.


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:

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:

Getting help

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

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.

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

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:

Also, disable the certificate for npm:

Authentication

To log into the Amplify Platform, run:

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:

To install a package, run:

To list installed packages, run: