---
schema_version: "1"
id: a368d6d3155134e767d105551f63305ea4298ba45ce9a07c692ebf5b18768739
title: Install Anypoint CLI 4.x
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/anypoint-cli/latest/install.md
canonical_url: https://docs.mulesoft.com/anypoint-cli/latest/install
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 9ffd35830f11f60c601665962c6a50f288c55e7bd4e09f72e77617107ba0b1e4
description: MuleSoft Documentation Site
release: 4.x
latest: true
---
---
product: Anypoint CLI
version: 4.x
is-latest-version: true
---

# Install Anypoint CLI 4.x

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Install Anypoint Platform CLI 4.x from npm to access command-line tools for Anypoint Platform and
Anypoint Platform Private Cloud Edition (PCE). The installation process includes
[installing prerequisite software](#prereqs),
[installing the CLI package with default plugins](#installation), and optionally
[installing nondefault plugins](#install-plugins). [Verify the installation](#verify-installation)
to ensure proper setup for automating platform operations and managing applications. CLI supports
both cloud and on-premises deployments, enabling integration with CI/CD workflows and enterprise
environments.

## Before You Begin

The Anypoint CLI is built with Node.js and is installed by using npm, the package manager for the
Node JavaScript platform.

Versions required are as follows:

- Node.js version 22.0.0 or later

- npm version 7 or later

To install the prerequisite software:

- Download and install Node.js and npm.

  See the [NodeJS download page](https://nodejs.org/en/download/).

Depending on the configuration of your system, you might need to log in using administrator
credentials before you can successfully run the npm commands.

## Install the Core Package and Default Plugins

Run the following command to install the Anypoint CLI core package and all default plugins. See
[List of Plugins](#plugin-list).

```text
npm install -g anypoint-cli-v4-public
```

## Install a Plugin Separately

After installing the Anypoint CLI 4.x core package, you can install nondefault plugins or new
versions of default plugins as follows:

```text
anypoint-cli-v4 plugins:install <plugin-name>
```

For example, to install the account plugin, use the following command:

```text
anypoint-cli-v4 plugins:install anypoint-cli-account-plugin
```

### List of Plugins

You can install the following plugins with Anypoint CLI:

<table><colgroup><col> <col></colgroup><thead><tr><th>Plugin</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p>anypoint-cli-account-plugin</p></div></div></td><td><div><div><p>Account command topics</p></div></div></td></tr><tr><td><div><div><p>mulesoft-anypoint-cli-agent-fabric-plugin</p></div></div></td><td><div><div><p>Agent Fabric command topics</p></div></div></td></tr><tr><td><div><div><p>anypoint-cli-api-manager-plugin</p></div></div></td><td><div><div><p>API Manager command topics</p></div></div></td></tr><tr><td><div><div><p>anypoint-cli-cloudhub-plugin</p></div></div></td><td><div><div><p>CloudHub and CloudHub 2.0 command topics</p></div></div></td></tr><tr><td><div><div><p>anypoint-cli-datagraph-plugin</p></div></div></td><td><div><div><p>Anypoint DataGraph command topics</p></div></div></td></tr><tr><td><div><div><p>@salesforce/anypoint-cli-dx-mule-plugin</p></div></div></td><td><div><div><p>DX Mule command topics</p></div></div></td></tr><tr><td><div><div><p>anypoint-cli-exchange-plugin</p></div></div></td><td><div><div><p>Exchange command topics</p></div></div></td></tr><tr><td><div><div><p>mulesoft-anypoint-cli-designcenter-plugin</p></div></div></td><td><div><div><p>Design Center command topics</p></div></div></td></tr><tr><td><div><div><p>mulesoft-anypoint-cli-governance-plugin</p></div></div></td><td><div><div><p>API Governance command topics</p></div></div></td></tr><tr><td><div><div><p>anypoint-cli-runtime-mgr-plugin</p></div></div></td><td><div><div><p>Runtime Manager command topics</p></div></div></td></tr><tr><td><div><div><p>anypoint-cli-secrets-mgr-plugin</p></div></div></td><td><div><div><p>Secrets Manager command topics</p></div></div></td></tr></tbody></table>

> [!NOTE] The API Governance plugin npm package name is now
> `mulesoft-anypoint-cli-governance-plugin`. The old name `anypoint-cli-governance-plugin` is
> deprecated. If you use the old name, see
> [Migrate to the New Governance Plugin Package Name](#migrate-governance-plugin).

#### Migrate to the New Governance Plugin Package Name

To migrate to the new package name `mulesoft-anypoint-cli-governance-plugin`:

1.  In your `package.json` file, replace the `"anypoint-cli-governance-plugin": "1.0.x"` dependency
    with `"mulesoft-anypoint-cli-governance-plugin": "1.0.19"`.

2.  For oclif hosts, such as Anypoint CLI v4, update the entry in the `oclif.plugins` array from
    `"anypoint-cli-governance-plugin"` to `"mulesoft-anypoint-cli-governance-plugin"`.

3.  Run `npm install` to refresh your lockfile.

4.  Regenerate the oclif manifest and README by running `oclif manifest && oclif readme` if your
    host publishes one.

## Verify the Installation

After you install Anypoint CLI you can verify the installation using commands to:

- [View the Core Package Version](#view-core-version)

- [View the List of Plugins Installed](#view-plugin-list)

- [View All Version Information](#view-all-version-info)

### View the Core Package Version

To view the version of the core package:

```text
anypoint-cli-v4 --version
```

The output shows the version of the installed core package as follows:

anypoint-cli-v4/1.x.x <OS-version> node-v16.x.x

### View the List of Plugins Installed

To verify a plugin installation and view a list of all installed plugins, use the following command:

```text
anypoint-cli-v4
```

The output shows the installed plugins under the `TOPICS` section. The following example shows that
only the account plugin is installed:

VERSION anypoint-cli-v4/x.x.x <OS-version> node-vx.x.x

USAGE $ anypoint-cli-v4 \[COMMAND\]

TOPICS account Show details of a business group. If "name" is omitted, defaults to the current
session's business group plugins list installed plugins

COMMANDS help display help for anypoint-cli plugins list installed plugins

### View All Version Information

To see the list of installed plugins along with full version information, use the following command:

```text
anypoint-cli-v4 plugins --core
```

The output shows the version information:

$ anypoint-cli-v4 plugins --core @oclif/plugin-help 5.1.15 (core) @oclif/plugin-not-found 2.3.4
(core) @oclif/plugin-plugins 2.1.2 (core) @oclif/plugin-version 1.1.3 (core)
anypoint-cli-account-plugin 1.0.0 (core) anypoint-cli-api-mgr-plugin 1.0.0 (core)
anypoint-cli-cloudhub-plugin 1.0.0 (core) anypoint-cli-command 1.0.1 (core)
anypoint-cli-designcenter-plugin 1.0.2 (core) anypoint-cli-exchange-plugin 1.0.0 (core) └─conf-cli
0.1.9 (core) anypoint-cli-runtime-mgr-plugin 1.0.0 (core) anypoint-cli-v4 1.0.2 (core)

## Link a Local Plugin for Development

To link a local plugin directory into the CLI for development purposes:

```text
anypoint-cli-v4 plugins:link <path>
```

For example, to link a plugin in the current directory:

```text
anypoint-cli-v4 plugins:link .
```

> [!NOTE] Installing a linked plugin overrides a user-installed or core plugin that has the same
> commands.

## Enable Shell Autocomplete

To display autocomplete installation instructions for your shell:

```text
anypoint-cli-v4 autocomplete [bash|zsh|powershell]
```

For example, to set up autocomplete for Zsh:

```text
anypoint-cli-v4 autocomplete zsh
```

To refresh the autocomplete cache after installing new plugins:

```text
anypoint-cli-v4 autocomplete --refresh-cache
```

## Uninstall a Plugin

Uninstall plugins if, for example, you want to reduce the number to only those you use regularly.

To uninstall a plugin:

```text
anypoint-cli-v4 plugins:uninstall anypoint-cli-<plugin-name>-plugin
```

For example, the following command uninstalls the account plugin:

```text
anypoint-cli-v4 plugins:uninstall anypoint-cli-account-plugin
```

See [List of Plugins](#plugin-list).

## Uninstall Anypoint CLI

You might want to uninstall Anypoint CLI from systems where it is no longer being used.

To uninstall the Anypoint CLI:

```text
npm uninstall -g anypoint-cli-v4-public
```