Skip to end of metadata
Go to start of metadata

The AMPLIFY CLI pm command allows you to manage, install, and uninstall packages.

Usage

Commands

  • i, install - Installs a specific package

  • ls, list - Lists all installed accounts
  • purge - Removes all non-active packages
  • s, search - Searches registry for packages
  • rm, uninstall - Removes the specified package
  • update - Download updates for installed packages
  • use - Activates a specific package version
  • v, view - Displays info for a specific package

i, install

Installs a package. Multiple versions of the same package may be installed simultaneously. Run the use command (see below) to choose which version is active.

Options

  • --json - Outputs installed package as JSON

ls, list

Displays a list of all installed packages.

Options

  • --json - Outputs accounts as JSON

purge

Uninstall all non-active, managed packages. This is useful after installing a newer version or running the update command. Note that only managed packages, packages that were installed via the AMPLIFY CLI package manager, will be removed.

Options

  • --json - Outputs purged packages as JSON

s, search

Searches the registry for a package. If no search criteria is specified, every package in the registry is returned.

Options

  • --json - Outputs packages as JSON
  • --repository <repo> - The originating repository
  • --type <type> - The type of package

Currently, the only supported repository is "npm".

Available package types include "amplify-cli-plugin" and "central-cli-plugin".

rm, uninstall

Removes a single or all versions of a package.

If no version is specified, then all versions of the package are removed.

Options

  • --json - Outputs removed packages as JSON

update

Checks for package updates, then downloads, installs, and marks them as active.

Options

  • --json - Outputs updated packages as JSON

use

Activates a specific package version. This is useful when multiple versions of a package are installed.

If no version is specified, then it will default to the "latest" version.

Options

  • --json - Outputs activated package as JSON

v, view

Displays information about a package from the registry.

If no version is specified, then it will default to the "latest" version.

The filter argument is used to display a specific field such as "name" or "version".

Options

  • --json - Outputs package info as JSON
  • No labels