Download the PHP package bernskioldmedia/helm-wp without Composer
On this page you can find all versions of the php package bernskioldmedia/helm-wp. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bernskioldmedia/helm-wp
More information about bernskioldmedia/helm-wp
Files in bernskioldmedia/helm-wp
Package helm-wp
Short Description A local development framework for WordPress.
License MIT
Homepage https://bernskioldmedia.com
Informations about the package helm-wp
Helm WP
Helm is Bernskiold Media's WordPress development framework. It's meant to be loaded as a Composer dev depenency and proves a set of tools to help you develop WordPress themes and plugins. Helm is heavily inspired by/a WordPress adapted fork of Laravel Sail.
Installation
To install, your project must be using composer. Require the package to your project:
After installing, place a docker-compose.yml
file in the root of your project. You can use the following as a starting
point:
Running helm
Helm ships with its own helm
command. This is a wrapper around the docker-compose
command that makes it easier to
run commands inside the container.
Adapt the path in the command to match your project structure and where composer packages are installed in your project, if you have customized your vendor folder.
For more information on the helm
command, run ./vendor/bin/helm help
.
Creating an alias command
This alias enables you to just type helm to reach our Helm WP environment instead of having to always type the full path
to the vendor/bin
directory.
Starting the container
To start the container, run:
Stopping the container
To stop the container, run:
Running commands inside the container
Helm supports running commands from within the container. This is useful for running Composer commands, WP CLI commands and more.
Using a different PHP version
Helm ships with support for PHP versions from 7.4 to 8.2, although we recommend not using 7.4 for anything new as it has been officially deprecated.
To use a different PHP version, change the context
in the wordpress.test
service to point to the correct runtime
folder. You should also change the image
to match the runtime folder name.
For example, to use PHP 8.1, change it to:
The available runtimes are:
7.4
8.0
8.1
8.2
Running Helm Migrate
Helm ships with a helper helm-migrate
command to help migrate a production database to the local help environment.
It requires a wp-cli.yml
file in the root of your project. You can use the following as a starting point:
To migrate the database, run:
For more information on the helm-migrate
command, run ./vendor/bin/helm-migrate help
.
WordPress Multisite Support
Helm Migrate supports WordPress Multisite out of the box. To migrate the entire environment you only need to run the run command as above. However, sometimes you only want to migrate one or a few sites in a large network.
To do this, you use the selection
command along with the envrionment name. It will then ask you for the site IDs.