VIP-CLI
VIP-CLI is a command-line interface for interacting with VIP Platform applications and environments. Once VIP-CLI is installed on a local machine, it can be used to run WP-CLI commands and perform actions like syncing data from production to development environments.
To run a VIP-CLI command against an application’s environment, a user must have an App write role or greater for that application. A user’s access level for interacting with individual applications with VIP-CLI is determined by the permission levels set by the Org role and App role assigned to them.
A VIP-CLI command can only be run against one environment at a time. A specific application and its environment must be targeted by a VIP-CLI command.
-
WP-CLI with VIP-CLI
On VIP, WP-CLI commands must be run in the command line using the VIP-CLI `vip wp` command. VIP-CLI also includes a WP-CLI console mode that provides a terminal-like interface to a WordPress site.
-
Install VIP-CLI
VIP-CLI can be installed through a package manager like npm. After VIP-CLI is successfully installed, authentication with a Personal Access Token is required to access VIP-CLI commands that interact with VIP Platform applications and environments.
-
Target environments with VIP-CLI commands
A VIP-CLI command can only be run against one environment at a time. Both an application and an environment type must be specified in a VIP-CLI command.
-
VIP-CLI command reference
A complete reference for all existing VIP-CLI commands, their options, and examples for their use. The content of the VIP-CLI command reference is generated from the VIP-CLI help menu.
-
Advanced usage
When running commands with VIP-CLI it is possible nest commands, loop commands, reference file input, write command output to a file, and other advanced operations.
-
Troubleshooting VIP-CLI
VIP-CLI commands may return errors or unexpected results for a variety of reasons. This page describes common errors and issues, their causes, and recommended resolutions.
Last updated: November 12, 2025