-
Notifications
You must be signed in to change notification settings - Fork 2
Command Reference
$ hp --help
Usage: hp [options] [command]
Commands:
init [options] Initialize a HelperPress project in the current directory & install it.
install Generate local config, migrate data in, build a WP install and configure Apache to serve it.
build [build-type] Build a full WordPress install based on build type (dev or dist) in current project. [dist]
pull [data-type] [environment] Pulls down the remote WP data type (db, uploads or both) from specified environment. [both] [_master]
push [data-type] [environment] Push up the remote WP data type (db, uploads or both) to specified environment. [both] [_master]
deploy [environment] Deploy current checked-out code to environment. [<current branch>]
hp init
Initialize a HelperPress project in the current directory. Interactively creates your project's helperpress.json file.
--skip-install
Exit after creating the project's configuration file.
hp install
Generate local config, migrate data in, build a WP install and configure Apache to serve it.
hp build [build-type]
Build a full WordPress install based on build type (dev or dist) in current project.
Specify the type of WordPress build. Default: dist
dev: This build type is for local development. It will also configure Apache and your hosts file if your configuration is setup that way. This only needs to be run once as your theme will be symlinked to the WordPress install it creates.
dist: This build type generates a WordPress install ready for production. It will execute your build tool as defined in your configuration and copy the theme distributable source to the install.
hp pull [data-type] [environment]
Pulls down the remote WP data type (db, uploads or both) from specified environment.
Specify the type of data to migrate. Default: both
db: The database. It will be searched and replaced using your HelperPress WordPress Configuration.
uploads: Everything in your wp-content/uploads directory. If your project is setup to use rewrite rules as the uploads_sync method, this will switch it to "copy".
both: The whole shebang.
The environment to migrate to.
Default: _master ("_master" is a special alias that resolves to whichever environment is defined as db_master)
hp push [data-type] [environment]
Push up the remote WP data type (db, uploads or both) to specified environment. See argument descriptions for Migrate Down above.
hp deploy [environment]
Deploy currently checked-out code to environment.
The environment to deploy to. Default: the current Git branch's corresponding environment