WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp scaffold package-github

wp scaffold package-github

Generate GitHub configuration files for your command.

In this article

Back to top

GitHub
View Open Issues (1) View Closed Issues (9) Create New Issue
This command runs on the before_wp_load hook, just before the WP load process begins. Creates a variety of files to better manage your project on GitHub. These files include:
  • .github/ISSUE_TEMPLATE – Text displayed when a user opens a new issue.
  • .github/PULL_REQUEST_TEMPLATE – Text displayed when a user submits a pull request.
  • .github/settings.yml – Configuration file for the Probot settings app.

Installing

Use the wp scaffold package-github command by installing the command’s package:

wp package install wp-cli/scaffold-package-command

Once the package is successfully installed, the wp scaffold package-github command will appear in the list of available commands.

Options

<dir>
Directory path to an existing package to generate GitHub configuration for.
[--force]
Overwrite files that already exist.

Global Parameters

These global parameters have the same behavior across all commands and affect how WP-CLI interacts with WordPress.
Argument Description
--path=<path> Path to the WordPress files.
--url=<url> Pretend request came from given URL. In multisite, this argument is how the target site is specified.
--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>] Perform operation against a remote server over SSH (or a container using scheme of “docker”, “docker-compose”, “docker-compose-run”, “vagrant”).
--http=<http> Perform operation against a remote WordPress installation over HTTP.
--user=<id\|login\|email> Set the WordPress user.
--skip-plugins[=<plugins>] Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded.
--skip-themes[=<themes>] Skip loading all themes, or a comma-separated list of themes.
--skip-packages Skip loading all installed packages.
--require=<path> Load PHP file before running the command (may be used more than once).
--exec=<php-code> Execute PHP code before running the command (may be used more than once).
--context=<context> Load WordPress in a given context.
--[no-]color Whether to colorize the output.
--debug[=<group>] Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help.
--prompt[=<assoc>] Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values.
--quiet Suppress informational messages.

Command documentation is regenerated at every release. To add or update an example, please submit a pull request against the corresponding part of the codebase.