Variable VVV - The Best VVV Site Wizard

 ██    ██ ██    ██
░██   ░██░██   ░██     Variable VVV 1.7.2
░░██ ░██ ░░██ ░██
 ░░████   ░░████       The easiest way to set up
  ░░██     ░░██        WordPress sites with VVV!
   ░░       ░░

vv makes it extremely easy to create a new WordPress site using Varying Vagrant Vagrants. vv supports site creation with many different options; site blueprints to set up all your plugins, themes, and more; deployments; and lots more features.

Installation

If you have Homebrew installed, you run the following in your terminal application:

$ brew install bradp/vv/vv

Otherwise you'll want to clone and edit your $PATH to include the vv core file.

Updating

vv is currently under development, and you'll probably want the latest and greatest version at all time.

You can run vv --update to update to the latest version. This will update via Homebrew if you've installed it that way, otherwise vv will boostrap an update on where ever you've installed it.

vv will automatically check for updates and update itself once a week. You can disble this by adding "auto_update_disable": false to the JSON config in ~/.vv-config.

If you have trouble updating, you may want to try some of the options below:

Homebrew sometimes caches a version of Variable VV causing you to receive a message saying you are out of date with the Github version, however running vv --update simply downloads a version you already have installed. In cases like this, there are two safe options you can try.

First, and simplest, run vv --force-update. Second, if that does not work you can safely uninstall Variable VV and re-install it via homebrew, you can do this with these commands: brew remove vv then brew untap bradp/vv and finally, run the install command brew install bradp/vv/vvas mentioned above. You will not lose any settings or sites.

Usage

Once installed, you can run vv anywhere you'd like. If vv can't automatically find your VVV installation, you will be prompted for the path. It will also save this into a configuration file in ~/.vv-config, so you won't be prompted again.

At any time, you can run vv or vv --help to see a list of all possible options and flags.

vv will prompt you for a value for any required flags that were not specified.

The main commands are list, create, delete. These will list your sites, create a site, and delete a site. These each have a few aliases, so for example, if you run vv show, vv will know you meant vv list.

To start creating a site, simply do vv create ( you can also do vv --create, or simply vv -c). You will then be prompted for all required options.

All options and flags are listed below.

Site Creation

vv create

Creating a site does the following:

Halts Vagrant (if running)
Creates a web root for the site in the www folder containing three files: vvv-init.sh, wp-cli.yml, and vvv-hosts
- vvv-init.sh tells Vagrant to create a database if one does not exist and install the latest version of WordPress (via WP-CLI) the next time Vagrant is provisioned
- wp-cli.yml tells WP-CLI that WordPress is in the htdocs folder
- vvv-hosts contains the hosts entry to give your site a nice custom domain (the domain is set in the wizard)
Creates a file in the nginx-config folder to handle server settings for your site
Restarts Vagrant with vagrant up --provision

Provisioning Vagrant takes a couple of minutes, but this is a crucial step as it downloads WordPress into your site's htdocs directory and runs the installation. If you want to skip provisioning and install WordPress manually, you can run the new site's vvv-init.sh file directly in the Vagrant shell.

Site Deletion

vv delete

Deleting a site does the following:

Halts Vagrant (if running)
Deletes the site's web root (which deletes the vvv-init.sh, wp-cli.yml, and vvv-hosts files as well)
Deletes the file in the nginx-config folder pertaining to the site
Deletes the database associated with the site

Deployments

vv deployment-create, vv deployment-remove, vv deployment-config

vv supports setting up deployments that work with Vagrant Push. You'll need to be on version 1.7.0 or later of Vagrant. Simply run vv --deployment-create and walk through the wizard.

To deploy a site, you can do vv vagrant push <sitename><deployment_name>.

When removing a deployment, your current Vagrantfile will be backed up as Vagrantfile-backup.

Advanced Usage

Anything that vv prompts you for, you can pass in as an argument. Most of this is realized in the site creation. In fact, there are a few arguments you can pass in that aren't prompted. This gives you total control over creating a new site.

To create a new site named 'mysite' that has the domain 'mysite.dev' and is a multisite with subdomains, with WP_Debug turned on would be:

vv create -d mysite.dev -n mysite -m subdomains -x

Or, the more readable version with all expanded flags.

vv create --domain mysite.dev --name mysite --multisite subdomains --debug

Blueprints

Blueprints allow you to set up different plugins, themes, mu-plugins, options, or constants that will be installed to a new site you create. First, run vv --blueprint-init to have vv create a vv-blueprints.json file in your VVV directory. You can edit this file to create and set up different blueprints.

The blueprint should look like this:

{
  "sample": {
    "themes": [
      {
        "location": "automattic/_s",
        "activate": true
      }
    ],
    "mu_plugins": [
      {
        "location": "https://github.com/WebDevStudios/WDS-Required-Plugins.git"
      }
    ],
    "plugins": [
      {
        "location": "https://github.com/clef/wordpress/archive/master.zip",
        "version": null,
        "force": false,
        "activate": true,
        "activate_network": false
      },
      {
        "location": "cmb2",
        "version": "2.0.5",
        "force": false,
        "activate": true,
        "activate_network": false
      },
    ],
    "options": [
      "current_theme::_s"
    ],
    "defines": [
      "WP_CACHE::false"
    ]
  }
}

For themes, plugins, and mu-plugins, you can use:

Github username/repo
Full git url
Url to zip file
WordPress.org slug

The options for plugins and themes correspond to the equivelant WP CLI option.

For options and constants, please note the :: as a seperator between the key and value.

You can create as many named blueprints in this file as you would like, all with as many different settings as you'd like.

When creating a site, the name you've specified (in this example, "sample") is what you'll need to specify to use this blueprint.

Vagrant Proxy

Because vv knows where you VVV installation is, you can run it from anywhere. vv will proxy any commands passed into vv vagrant <command> to your VVV location. So vv vagrant halt will halt your VVV vagrant, no matter where you run it.

`vv` Options

Option	Description
`--help`, `-h`	Show help and usage
`--version`	Show current vv version number.
`--about`	Show about screen.
`--update`	Updates vv to the latest stable version
`--path`, `-p`	Path to VVV installation
`--force-path`, `-fp`	Override vv auto-VVV locating
`--force-sites-folder`,`-fsf`	Override sites folder directory locating
`--defaults`	Accept all default options and skip the wizard

Commands

Command	Description
`list`, `--list`, `-l`	List all VVV sites
`create`, `--create`, `-c`	Create a new site
`remove`, `--remove`, `-r`	Remove a site
`deployment-create`, `--deployment-create`	Set up deployment for a site
`deployment-remove`, `--deployment-remove`	Remove deployment for a site
`deployment-config`, `--deployment-config`	Manually edit deployment configuration
`blueprint-init`, `--blueprint-init`	Initalize blueprint file
`vagrant`, `v`, `--vagrant`, `-v`	Pass vagrant command through to VVV.

Options for Site Creation

Option	Description
`--name`, `-n`	Desired name for the site directory (e.g. mysite)
`--domain, -d`	Domain of new site
`--webroot`, `-wr`	Subdirectory used for web server root
`--blueprint`, `-b`	Name of blueprint to use
`--live-url`, `-u`	Live URL of site
`--files`, `-f`	Do not provision Vagrant, just create the site directory and files
`--images`, `-i`	Load images by proxy from the live site
`--wp-version`, `-wv`	Version of WordPress to install
`--debug`, `-x`	Turn on WP_DEBUG and WP_DEBUG_LOG
`--multisite`, `-m`	Install as a multisite. Can also pass in "subdomain" or "subdirectory"
`--sample-content`,`-sc`	Adds sample content to site.
`--username`	Admin username
`--password`	Admin password
`--email`	Admin email
`--git-repo`,`-gr`	Git repo to clone as wp-content
`--path`, `-p`	Path to VVV installation
`--force-path`, `-fp`	Override vv auto-VVV locating
`--blank`	Creates blank VVV site, with no WordPress
`--blank-with-db`	Creates a blank VVV site, with a database
`--wpskeleton`, `-skel`	Creates a new site with the structure of WP Skeleton`
`--database`,`-db`	Imports a local database export
`--remove-defaults`,`-rd`	Removes default themes and plugins

Options for Site Removal

Option	Description
`--name`, `-n`	Desired name for the site directory (e.g. mysite)
`--path`, `-p`	Path to VVV installation
`--force_path`, `-fp`	Override vv auto-VVV locating

Options for Deployment Setup

Option	Description
`--name`, `-n`	Desired name for the site directory (e.g. mysite)
`--deployment-name`	Name of deployment (production, staging, other, etc)
`--host`	Host (if SFTP, define port as host:port)
`--username`	FTP Username
`--password`	FTP Password
`--passive`	Use Passive transfer mode? (y/n)
`--secure`	Use SFTP? (y/n)
`--destination`	Destination path ( You probably want / or ~/public_html )
`--confirm-removal`	Used when removing a deployment to skip the confirmation prompt

`.vv-config`

The first time you run vv, it will attempt to locate your VVV installation location. If it can't find it, you will be prompted for it. This will be written to a .vv-config file in your home directory. (~/.vv-config) You can also edit this file if you need to change your VVV path.

You can also add "auto_update_disable": false to this file to disable auto-update functionality.

Questions?

Ping me on Twitter at @bradparbs.

Thanks

Forked and based off of vvv-site-wizard from Alison Barrett. Also thanks to creativecoder, jtsternberg, tnorthcutt, joehills, gregrickaby, leogopal, Mte90, Octopixell, wpsmith for awesome contributions.

aroscoe82/vv