vip dev-env create

Create a new local environment.

Usage

vip dev-env create [options]

Options

Option	Description
-a, --app-code	Manage the source for application code. Accepts “demo” (default) for a read-only image of WordPress VIP skeleton application code, or a path to a VIP formatted application repo on the local machine.
-c, --cron	Enable or disable cron, disabled by default. Accepts “y” (default value) to enable or “n” to disable.
-d, --debug	Generate verbose output during command execution to help identify or fix errors or bugs.
-e, --elasticsearch	Enable or disable Elasticsearch (required by Enterprise Search), disabled by default. Accepts “y” (default value) to enable or “n” to disable.
-h, --help	Retrieve a description, examples, and available options for a (sub)command.
-A, --mailpit	Enable or disable Mailpit, disabled by default. Accepts “y” (default value) to enable or “n” to disable.
-r, --media-redirect-domain	Configure media files to be proxied from a VIP Platform environment. Accepts a string value for the primary domain of the VIP Platform environment or “n” to disable the media proxy.
-u, --mu-plugins	Manage the source for VIP MU plugins. Accepts “demo” (default) for a read-only image of the staging branch, or a path to a built copy of VIP MU plugins on the local machine.
-m, --multisite	Create environment as a multisite. Accepts “y” for a subdomain multisite, “subdirectory” (recommended) for a subdirectory multisite, or “false”. Default is “y”.
-H, --photon	Enable or disable Photon, disabled by default. Accepts “y” (default value) to enable or “n” to disable.
-P, --php	Manage the version of PHP. Accepts a string value for minor versions: 8.2, 8.1, 8.3
-p, --phpmyadmin	Enable or disable phpMyAdmin, disabled by default. Accepts “y” (default value) to enable or “n” to disable. When enabled, refer to the value of “PHPMYADMIN URLS” in the information output for a local environment for the URL to access phpMyAdmin.
-s, --slug	A unique name for a local environment. Default is “vip-local”.
-t, --title	A descriptive value for the WordPress Site Title. Default is “VIP Dev”.
-v, --version	Retrieve the version number of VIP-CLI currently installed on the local machine.
-w, --wordpress	Manage the version of WordPress. Accepts a string value for major versions (6.x). Defaults to the most recent version of WordPress.
-x, --xdebug	Enable or disable XDebug, disabled by default. Accepts “y” (default value) to enable or “n” to disable.
-X, --xdebug_config	Override some default configuration settings for Xdebug. Accepts a string value that is assigned to the XDEBUG_CONFIG environment variable.

Examples

- Create a new VIP Local Development Environment.
* The environment will be named "vip-local" by default if a custom name is not assigned with "--slug" .
$ vip dev-env create

- Create a new local environment with the unique name "example-site".
* Unique names allow multiple local environments to exist simultaneously.
$ vip dev-env create --slug=example-site

- Create a new local environment configured as a multisite running PHP 8.2 and WordPress version 6.4.
* Options that are set in the `create` command will be skipped in the setup wizard.
$ vip dev-env create --slug=example-site --multisite=y --php=8.2 --wordpress=6.4

- Create a new local environment with settings based on the production environment of the "example-app" application and load the locally git-cloned application repository "example-repo".
$ vip @example-app.production dev-env create --slug=example-site --app-code=/Users/example/Desktop/example-repo