Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
https://github.com/aaemnnosttv/wp-cli-valet-command

Harness the power of Laravel Valet for creating fully functional WordPress installs in seconds.
https://github.com/aaemnnosttv/wp-cli-valet-command
Last synced: 3 months ago
JSON representation
Harness the power of Laravel Valet for creating fully functional WordPress installs in seconds.
Host: GitHub
URL: https://github.com/aaemnnosttv/wp-cli-valet-command
Owner: aaemnnosttv
Created: 2016-05-13T19:15:58.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2023-12-27T22:29:22.000Z (6 months ago)
Last Synced: 2024-03-21T11:44:36.688Z (3 months ago)
Language: PHP
Homepage: https://aaemnnost.tv/wp-cli-commands/valet/
Size: 175 KB
Stars: 291
Watchers: 15
Forks: 30
Open Issues: 6
Metadata Files:
- Readme: README.md
Lists

awesome-stars - wp-cli-valet-command - Harness the power of Laravel Valet for creating fully functional WordPress installs in seconds. (PHP)
README

        aaemnnosttv/wp-cli-valet-command

================================

White-glove services for turn-key installs in seconds.

[![Travis Build](https://img.shields.io/travis/aaemnnosttv/wp-cli-valet-command/master.svg)](https://travis-ci.org/aaemnnosttv/wp-cli-valet-command) [![Packagist](https://img.shields.io/packagist/v/aaemnnosttv/wp-cli-valet-command.svg)](https://packagist.org/packages/aaemnnosttv/wp-cli-valet-command)

Quick links: [Using](#using) | [Installing](#installing) | [Troubleshooting](#troubleshooting) | [Support](#support) | [Contributing](#contributing)

## Using

This package implements the following commands:

### wp valet new

Create a new WordPress install -- fast

~~~

wp valet new  [--project=] [--in=] [--version=] [--locale=] [--db=] [--dbname=] [--dbuser=] [--dbpass=] [--dbhost=] [--dbprefix=] [--admin_user=] [--admin_password=] [--admin_email=] [--unsecure] [--portable]

~~~

This command will spin up a new WordPress installation -- complete with database and https

_ready-to-use in your browser_ faster than you can put your pants on.

**OPTIONS**

	

		Site domain name without TLD. This will become the directory name of the project root.

		Eg: To create an install for example.dev, `wp valet new example`

	[--project=]

		The WordPress project to install. Choose from any project supported by Laravel Valet.

		---

		default: wp

		options:

		  - wp

		  - bedrock

		---

	[--in=]

		Specify the path to the parent directory to create the install in.

		Defaults to the current working directory.

	[--version=]

		WordPress version to install.

		---

		default: latest

		---

	[--locale=]

		Select which language you want to install.

	[--db=]

		Database driver to provision the site with.

		---

		default: mysql

		options:

		  - mysql

		  - sqlite

		---

	[--dbname=]

		Database name (MySQL only).

		Defaults to 'wp_'.

	[--dbuser=]

		Database User (MySQL only).

		---

		default: root

		---

	[--dbpass=]

		Set the database user password (MySQL only).

		---

		Default: ''

		---

	[--dbhost=]

		Set the database host.

		---

		default: localhost

		---

	[--dbprefix=]

		Set the database table prefix.

		---

		default: 'wp_'

		---

	[--admin_user=]

		The username to create for the WordPress admin user.

		---

		default: admin

		---

	[--admin_password=]

		The password to create for the WordPress admin user.

		---

		default: admin

		---

	[--admin_email=]

		The email to use for the WordPress admin user.

	[--unsecure]

		Provision the site for http rather than https.

	[--portable]

		Provision the site to be portable. Implies --unsecure and --db=sqlite.

### wp valet destroy

Completely remove an installation.

~~~

wp valet destroy  [--yes]

~~~

This will drop the database, and delete all of the files as well as

remove any self-signed TLS certificate that was generated for serving

this install over https.

**OPTIONS**

	

		Site domain name without TLD. It should match the directory name of the project root.

	[--yes]

		Pre-approve the confirmation to delete all files and drop the database.

## Installing

This command leverages [Laravel Valet](https://laravel.com/docs/valet) -- an open source development environment for Mac + \*nix minimalists. 

It runs various commands lightning fast, allowing you to spin up a site in your browser immediately after creating it, without any other configuration, all from a single command.

You should also understand how Valet works, especially the portion on [Serving Sites](https://laravel.com/docs/5.2/valet#serving-sites).

#### Environment Setup

0) MacOS users should install [Homebrew](https://brew.sh/) first.

1) Follow the [Valet installation instructions](https://laravel.com/docs/valet#installation) on the Laravel documentation to get started.

> _Note: Linux users should use [Valet-linux](https://github.com/cpriego/valet-linux) instead, a fork of the original project that shares most of the same `valet` commands powering this `wp-cli` plugin._

2) Confirm your `wp-cli` environment works and meets the minimum version specified below by running `wp cli info` and proceed if the output looks something like:

```

PHP binary:	/usr/bin/php7.0

PHP version:	7.0.22-0ubuntu0.16.04.1

php.ini used:	/etc/php/7.0/cli/php.ini

WP-CLI root dir:	phar://wp-cli.phar

WP-CLI vendor dir:	phar://wp-cli.phar/vendor

WP_CLI phar path:	/home/user/wp-cli-valet-command

WP-CLI packages dir:	/home/user/.wp-cli/packages/

WP-CLI global config:	/home/user/.wp-cli/config.yml

WP-CLI project config:	

WP-CLI version:	1.4.1

```

Update, if needed, to the latest stable release with `wp cli update`.

#### Loading the wp-cli-valet-command package

Installing this package requires WP-CLI v1 || v2 or greater. Update to the latest stable release with `wp cli update`.

Once you've done so, you can install the latest stable version of this package with:

```bash

wp package install aaemnnosttv/wp-cli-valet-command:@stable

```

To install the latest development version of this package, use the following command instead:

```bash

wp package install aaemnnosttv/wp-cli-valet-command:dev-master

```

## Troubleshooting

`Error: ERROR 1045 (28000): Access denied for user 'root'@'localhost'`

The installer halts at the database creation stage because it doesn't have a password for your local `MySQL` instance.

Prevent this from happening by appending your `wp valet` commands like such: `wp valet new site --dbpass=local_root_password`.

At this point, you can: 

1) Either create a `wp-config.php` file manually,

2) use `wp config`command to have wp-cli create one for you, or 

3) use `wp valet destroy site` and try running your `wp valet new` command again, this time using the `--dbpass` attribute.

### Configuring Alternate Defaults

As with other `wp-cli` commands, you can set default attributes when running `wp valet`.

Simply add the appropriate details in `~/.wp-cli/config.yml`:

```yml

valet new:

  ## Uncomment or update the relevant lines when necessary to set your own defaults.

  project: wp # or bedrock

  # in: # override - defaults to current directory

  version: latest

  # locale:  # use if not English

  db: mysql # or sqlite

  # dbname: # defaults to wp_name

  dbuser: root # or any other local user capable of creating databases (MySQL only)

  # dbpass: # enter the appropriate password if necessary (MySQL only)

  dbprefix: wp_

  admin_user: admin

  admin_password: admin

  ## Boolean options can also be configured, too.

  # unsecure: false # set to true to override

  # portable: false # set to true to override

```

The `wp valet new` defaults are shown here as an example for clarity.

One simple usage for the `config.yml` could look like

```yml

valet new:

  dbuser: root # or any db creating user

  dbpass: password # set yours here

```

to enable `wp valet new site` to spin up a full, live, running local WordPress site in ~3 seconds without any additional parameters.

## Support

GitHub issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support

## Contributing

We appreciate you taking the initiative to contribute to this project.

Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.

For a more thorough introduction, [check out WP-CLI's guide to contributing](https://make.wordpress.org/cli/handbook/contributing/). This package follows those policy and guidelines.

### Reporting a bug

Think you’ve found a bug? We’d love for you to help us get it fixed.

Before you create a new issue, you should [search existing issues](https://github.com/aaemnnosttv/wp-cli-valet-command/issues?q=label%3Abug%20) to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.

Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please [create a new issue](https://github.com/aaemnnosttv/wp-cli-valet-command/issues/new). Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, [review our bug report documentation](https://make.wordpress.org/cli/handbook/bug-reports/).

### Creating a pull request

Want to contribute a new feature? Please first [open a new issue](https://github.com/aaemnnosttv/wp-cli-valet-command/issues/new) to discuss whether the feature is a good fit for the project.

Once you've decided to commit the time to seeing your pull request through, [please follow our guidelines for creating a pull request](https://make.wordpress.org/cli/handbook/pull-requests/) to make sure it's a pleasant experience. See "[Setting up](https://make.wordpress.org/cli/handbook/pull-requests/#setting-up)" for details specific to working on this package locally.

*This README.md is generated dynamically from the project's codebase using `wp scaffold package-readme` ([doc](https://github.com/wp-cli/scaffold-package-command#wp-scaffold-package-readme)). To suggest changes, please submit a pull request against the corresponding part of the codebase.*