Skip to content

How-to Guides

Technical References

Tools for Site Management /

VIP CLI

VIP CLI is the command line interface for VIP Go. You can use VIP CLI to interact with your VIP applications, query information about your applications, and perform actions like syncing data from production to development environments.

VIP CLI is aimed at developers, so familiarity with installing CLI applications and using the Terminal is required. VIP also offers the web-based VIP Dashboard, which will provide access to similar functionality in a graphical user interface.

What commands does the CLI offer?

You can view the available commands with the vip --help command:

$ vip --help

Usage: vip [options] [command]

Commands:

app List and modify your VIP Go apps
help Display help
logout Logout from your current session
sync Sync production to a development environment

Options:

-h, --help Output usage information
-v, --version Output the version number

Installing VIP CLI locally

VIP CLI is a Node.js Package and can be installed through a package manager like npm.

VIP CLI requires Node.js v8.9.0+ and npm v5.7.1+. If either or both are below the required versions, see the upgrade steps in our troubleshooting section below.

To begin installation, visit our VIP CLI page installation page and follow the instructions.

Note

It is extremely important not to install VIP CLI using the sudo command; if this has been done you can follow the directions below.

Specifying app and environment

On VIP, each application has one or more environments, such as production, staging, or develop. For VIP CLI commands that run on a specific environment, VIP CLI will prompt you to choose an environment.

Environments can also be specified with an alias in the command, in the form of @<app-name>.<env>. Here’s an example command using an environment alias:

vip @wpvip.production -- wp option get home

Each environment can be specified by the unique app name, a dot separator, and the environment name. An environment’s alias can be found in the VIP Dashboard.

Troubleshooting

Status code 401

You may receive an error including the line Received status code 401, for example:

Failed to fetch apps: Error: Network error: Response not successful: Received status code 401

Please try the following:

  1. Run vip logout .
  2. Run vip and follow the prompts to log in again.

I can’t see all my applications

For you to access an application via VIP CLI, you must have at least read access to the GitHub repository for that application. If you do not see all the applications you expect when running vip app list, please follow this procedure:

  1. Check you have read access to the GitHub repository for the application(s) you expect to see. If you do not have access to these repositories on GitHub then you should contact someone on your team who has admin rights or alternatively contact VIP support.
  2. If you do have read access to the application repository on GitHub, but you do not see the application listed via vip app list then…
  3. Run vip logout .
  4. Run vip and follow the prompts to log in.
  5. Run vip app list. If you are still not seeing all the applications you expect then please get in touch with VIP support.

Note that to run some WP-CLI commands, you’ll need write access to the GitHub repository.

Installing Node

Please follow the Node.js project’s installation instructions.

Installing npm

Installing Node.js (instructions above) will include npm in the installation.

Upgrading Node.js

Follow the Node.js installation instructions to acquire and install the latest version of Node.js, or use the upgrade command if you installed via a package manager like Homebrew for macOS.

Upgrading npm

If you have npm installed already, you can run the following command to update to the latest version:

npm install -g npm

Fixing NPM/Node permissions

Read this npm guide: How to Prevent Permissions Errors.

If you have installed various commands with sudo you will need to reverse the process, fix the permissions errors, then install the command without the use of sudo. You should not use sudo to fix access permissions.

WARN install EACCES: permission denied

See “Fixing permissions” above.

Last updated: November 20, 2020