VIP CLI

VIP Go platform specific

This document is for sites running on VIP Go.

Learn more

Overview #

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.

↑ Top ↑

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

↑ Top ↑

Installing VIP CLI locally #

VIP CLI is offered as a Node Package, and it is installed through the Node Package Manager (npm) tool. Node.js should be equal to or newer than v7.10 and npm equal to or newer than v5.7.1, if either or both are lower, see the upgrade steps in our troubleshooting section below.

To begin installation, visit our VIP CLI page installation page and follow the instructions. It is extremely important not to install VIP CLI using the sudo command, if this has been done you can follow the directions below.

↑ Top ↑

Troubleshooting installation issues #

Installing Node #

Please follow the NodeJS project’s installation instructions.

↑ Top ↑

Installing NPM #

Installing NodeJS (instructions above) will include NPM in the installation.

↑ Top ↑

Upgrading Node #

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

↑ Top ↑

Upgrading NPM #

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

npm install -g npm

↑ Top ↑

Fixing 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.

↑ Top ↑

Help, I used sudo to install VIP CLI! #

You should not use sudo to fix access permissions, instead see “Fixing permissions above”.

↑ Top ↑

WARN install EACCES: permission denied #

See “Fixing permissions” above.

Ready to get started?

Drop us a note.

No matter where you are in the planning process, we’re happy to help, and we’re actual humans here on the other side of the form. 👋 We’re here to discuss your challenges and plans, evaluate your existing resources or a potential partner, or even make some initial recommendations. And, of course, we’re here to help any time you’re in the market for some robust WordPress awesomeness.