Skip to content

VIP Local Development Environment

Basic usage

Available commands for the VIP Local Development Environment and their options can be reviewed by running vip dev-env --help (or -h):

$ vip dev-env -h
  Usage: vip dev-env [options] [command]
  
  Commands:
    create   Create a new local dev environment
    destroy  Remove containers, networks, volumes and configuration files of a local dev environment
    exec     Execute an operation on a dev environment
    import   Import data into a local WordPress environment
    info     Provides basic info about one or multiple local dev environments
    list     Provides basic info about all local dev environments
    start    Start a local dev environment
    stop     Stop a local dev environment
    update   Update an already created local dev environment
  
  Options:
    -d, --debug    Activate debug output
    -h, --help     Output the help for the (sub)command
    -v, --version  Output the version number

Retrieve information about an environment

After a VIP Local Development Environment is created, information about the environment is output after commands such as create, start, and stop have completed.

Information about an environment can be retrieved on demand with the info command:

vip dev-env info --slug=<custom-name>

Information output:

  • NAME: The value assigned to the --title option
  • LOCATION: Path to the local environment on the local machine(e.g., /Users/user-name/.local/share/vip/dev-environment/example-site)
  • SERVICES: A list of available services provisioned in the local environment (e.g., Search Dev Tools, NGINX, PHP, database, memcached, Enterprise Search, WordPress, mu-plugins, client-code)
  • NGINX URLS: URLs for accessing a running local environment in a browser (e.g., http://example-site.vipdev.lndo.site/)
  • STATUS: State of the local environment (e.g., UP , DOWN)

Default WordPress login credentials

By default, a newly created local environment supplies a default WordPress user account with a Super Admin role.

Once a local environment is in an UP state, the WordPress admin can be accessed by appending the output NGINX URLS value with /wp-admin/.

For example: http://example-site.vipdev.lndo.site/wp-admin/

Default username: vipgo
Default password: password

Executing CLI commands

Use exec to execute commands against the local environment’s containers as opposed to the host machine. Separate the arguments of the vip process and the command to be executed with -- (two standard hyphens).

For example, to run the WP-CLI command wp post list against the WordPress site in the running local environment:

vip --slug=example-site dev-env exec -- wp post list

Because commands run with exec -- are running inside the local environment’s containers and not the host machine, paths to local files on the host machine might not work as expected.

Last updated: May 20, 2022