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 are run against specific environments by specifying the application and environment type. For example:
vip @mytestsite.preprod logs
|Retrieve a list of accessible VIP applications and related information|
|Manage environment variables for VIP application environments|
|Create a VIP Local Development Environment|
|Import media files or SQL files to an environment|
|Logout from a current VIP-CLI session|
|Retrieve Runtime Logs for an environment|
|Perform search and replace tasks on a SQL file prior to—or during—a file import|
|Sync data from production to non-production environments|
|Display details about the currently logged-in user|
|Run 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.
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.
Resources for more information about WP-CLI
- Installation and use: https://wp-cli.org/
- Handbook: https://make.wordpress.org/cli/handbook/
- Commands: https://developer.wordpress.org/cli/commands/
- Configuration: https://make.wordpress.org/cli/handbook/references/config/
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
- Per command by prepending the VIP-CLI command with
DO_NOT_TRACK=1 vip app list
- In the profile used most often in the local machine’s terminal application.