Skip to content


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 a user’s Org role and App role

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.

VIP-CLI commands

Available VIP-CLI commands and their options can be reviewed by running vip --help (or -h).

A help menu for individual commands can be reviewed by running: vip [command] -h

vip appRetrieve a list of accessible VIP applications based on a user’s permissions.
vip backupInteract with an environment’s Database Backups.
vip cachePurge one or more URLs sharing the same domain in a single command.
vip configConfigure environment variables and Software Management settings for VIP Platform environments.
vip dev-envCreate and manage a VIP Local Development Environment.
vip importImport media files or SQL files to an environment.
vip logoutLogout from a current VIP-CLI session.
vip logsRetrieve Runtime Logs for an environment.
vip search-replacePerform search and replace tasks on a SQL file prior to—or during—a file import.
vip syncSync data from production to non-production environments.
vip validateScan a Node.js codebase on a local machine and receive a report of potential issues.
vip whoamiDisplay details about the currently logged-in user.
vip wpUse VIP-CLI to run WP-CLI commands against an environment, including commands for Interacting with Enterprise Search indexes.


By default, VIP uses an in-house analytics system to record information about usage of the VIP-CLI tool. To opt-out of this data collection, set the DO_NOT_TRACK environment variable to 1:

  • Per command by prepending the VIP-CLI command with DO_NOT_TRACK=1.
    For example: DO_NOT_TRACK=1 vip app list
  • In the profile used most often in the local machine’s terminal application.
    For example: export DO_NOT_TRACK=1

Last updated: August 31, 2023

Relevant to

  • Node.js
  • WordPress