Skip to content

vip dev-env create

Create a new local environment.

Usage

vip dev-env create [options]

Options

OptionDescription
-a, --app-code Use the application code from a local directory or use “demo” for VIP skeleton code
-d, --debug Activate debug output
-e, --elasticsearch Enable Elasticsearch (needed by Enterprise Search)
-h, --help Output the help for the (sub)command
-A, --mailpit Enable Mailpit. By default it is disabled
-r, --media-redirect-domain Domain to redirect for missing media files. This can be used to still have images without the need to import them locally.
-u, --mu-plugins Use a specific mu-plugins changeset or local directory
-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 Photon. By default it is disabled
-P, --php Explicitly choose PHP version to use
-p, --phpmyadmin Enable PHPMyAdmin component. By default it is disabled
-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 Output the version number
-w, --wordpress Use a specific WordPress version
-x, --xdebug Enable XDebug. By default it is disabled
-X, --xdebug_config Extra configuration to pass to xdebug via 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

Last updated: June 05, 2024