Skip to content

Backgrounds

How-to Guides

Technical References

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.

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. The permissions for these roles are outlined in more detail in Roles & Permissions.

VIP-CLI commands

VIP-CLI commands are run against specific environments by specifying the application and environment type. For example: vip @mytestsite.preprod logs

CommandDescription
vip appRetrieve a list of accessible VIP applications and related information
vip configManage environment variables for VIP application environments
vip dev-envCreate 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 wpRun WP-CLI commands against an environment, including:
Flushing the page cache and Interacting with Enterprise Search indexes

Running WP-CLI commands with VIP-CLI

WP-CLI is a powerful and extensible way to interact with WordPress from the command line.

On VIP, WP-CLI commands must be run in the command line with VIP-CLI. Not all WP-CLI commands can be run against a VIP environment.

There is a limit of 4 CLI commands that can be run on a VIP environment concurrently. This limit applies whether the environment is a WordPress single site or a WordPress multisite.

A logged history of all Completed, Running, Cancelled or Errored WP-CLI commands can be viewed in the WP-CLI Commands panel in the VIP Dashboard.

In addition to the commands provided by WP-CLI , it is possible to write custom WP-CLI commands to accomplish tasks specific to the needs of an application on VIP.

Resources for more information about WP-CLI

Last updated: January 13, 2022