Title: Install VIP-CLI
Author: WordPress VIP Documentation
Published: December 24, 2020
Last modified: November 17, 2025

---

 1. [VIP-CLI](https://docs.wpvip.com/vip-cli/)
 2. Install VIP-CLI

#  Install VIP-CLI

VIP-CLI is a [Node.js](https://nodejs.org/) package that can be installed through
a package manager like [npm](http://npmjs.com/).

**Caution**

**Do not use the  **`sudo`** command** **during installation of** **VIP-CLI or Node.
js, or when running any VIP-CLI commands. **

If `sudo` is used to install a package, that package must be uninstalled. 
Permission
errors will need to be fixed. Do not use `sudo` to fix access permissions.

After the packages are uninstalled and permission repairs are complete, begin the
installation process again without the use of `sudo`.

**Prerequisite**

For **Windows** users, a compatible [WSL Linux distribution](https://learn.microsoft.com/en-us/windows/wsl/install)(
like [Ubuntu](https://ubuntu.com/wsl)) must be installed on the users local machine.
All VIP-CLI commands must be run via WSL in order to successfully run as expected.
This can be accomplished by installing and using [the WSL-compatible Windows Terminal application](https://learn.microsoft.com/en-us/windows/terminal/get-started)
for running VIP-CLI commands.

For security, performance and compatibility, WSL, Ubuntu, and Windows Terminal packages
should all be maintained at their most recent release versions.

## Install Node.js and npm

There are a wide variety of methods for [Installing Node.js via package manager](https://nodejs.org/en/download/package-manager/).
All methods of installing Node.js will also install npm.

Installing Node.js with the version manager **[nvm](https://nodejs.org/en/download/package-manager/#nvm)
is recommended**.

### Update Node.js and npm

VIP-CLI requires a minimum installed version of Node.js v20 and npm v9. It is recommended
to use the [latest active long-term support release](https://nodejs.org/en/about/previous-releases)
of Node.js, which is currently Node.js v24.

Retrieve the versions of Node.js and npm currently installed on the local machine
by running this command in the terminal:

    ```lang-shell
    node -v && npm -v
    ```

The package manager used to install Node.js and npm should also be used to manage
updates. Refer to the package manager’s documentation for instructions on updating
Node.js and npm.

### Node.js and npm permission issues

It is possible to experience permission issues when installing Node.js packages 
globally.

This error indicates the need to fix permissions:

    ```lang-shell
    WARN install EACCES: permission denied
    ```

[Follow this guide](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally)
to resolve the error by reinstalling npm with a Node Version Manager (recommended)
or manually changing npm’s default directory.

## Install VIP-CLI

After Node.js and npm are successfully installed, install the VIP-CLI npm package
by running this command in the terminal:

    ```lang-shell
    npm install -g @automattic/vip
    ```

## Authenticate VIP-CLI

Authentication with a [Personal Access Token](https://docs.wpvip.com/vip-dashboard/user-settings/#3-personal-access-token)
is required to access VIP-CLI commands that interact with VIP Platform applications
and environments.

**Prerequisites**

A user must have [access to the VIP Dashboard](https://docs.wpvip.com/vip-dashboard/vip-dashboard-log-in/)
to authenticate a [VIP-CLI](https://docs.wpvip.com/vip-cli/) installation.

 1. After the VIP-CLI npm package installation has completed, run the `vip` command
    in the terminal:

    ```lang-shell
    vip
    ```

 2. A prompt for `Ready to authenticate?` will appear in the terminal.
 3.  * Typing `y` will automatically open the VIP Dashboard User settings panel [where a user’s Personal Access Token can be retrieved](https://dashboard.wpvip.com/me/cli/token).
     * Typing `N` will cancel installation at the authentication step.
 4. Return to the terminal window and paste the Personal Access Token at the prompt
    for `Access Token:`.

A successful installation of VIP-CLI will automatically return output from the `
vip --help` command in the terminal.

## Update VIP-CLI

Updates are made regularly to VIP-CLI. Refer to the [VIP-CLI package manager](https://www.npmjs.com/package/@automattic/vip/v/latest)
for the current release version.

Available updates can be installed by running the following command in the terminal
of the local machine:

    ```lang-shell
    npm install -g @automattic/vip@latest
    ```

Retrieve the currently installed version of VIP-CLI on a local machine with this
command:

    ```lang-shell
    vip -v
    ```

## Uninstall VIP-CLI

To uninstall VIP-CLI from a local machine, run this command in the terminal:

    ```lang-shell
    npm uninstall -g @automattic/vip
    ```

This command will only uninstall the VIP-CLI package; it will not uninstall Node.
js or npm.

Last updated: November 17, 2025