Title: wp scaffold package-github
Published: May 31, 2023
Last modified: August 7, 2024

---

# 󠀁[wp scaffold package-github ](https://developer.wordpress.org/cli/commands/scaffold/package-github/)󠁿

Generate GitHub configuration files for your command.

## In this article

 * [Installing](https://developer.wordpress.org/cli/commands/scaffold/package-github/?output_format=md#installing)
 * [Options](https://developer.wordpress.org/cli/commands/scaffold/package-github/?output_format=md#options)
 * [Global Parameters](https://developer.wordpress.org/cli/commands/scaffold/package-github/?output_format=md#global-parameters)

[ Back to top](https://developer.wordpress.org/cli/commands/scaffold/package-github/?output_format=md#wp--skip-link--target)

 [ ⌊GitHub⌉ ](https://github.com/wp-cli/scaffold-package-command)

 [ View Open Issues (0) ](https://github.com/login?return_to=%2Fissues%3Fq%3Dlabel%3Acommand%3Ascaffold-package-github+sort%3Aupdated-desc+org%3Awp-cli+is%3Aopen)
[ View Closed Issues (11) ](https://github.com/login?return_to=%2Fissues%3Fq%3Dlabel%3Acommand%3Ascaffold-package-github+sort%3Aupdated-desc+org%3Awp-cli+is%3Aclosed)
[Create New Issue](https://github.com/wp-cli/scaffold-package-command/issues/new)

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](https://probot.github.io/apps/settings/).

### 󠀁[Installing](https://developer.wordpress.org/cli/commands/scaffold/package-github/?output_format=md#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](https://developer.wordpress.org/cli/commands/scaffold/package-github/?output_format=md#options)󠁿

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

### 󠀁[Global Parameters](https://developer.wordpress.org/cli/commands/scaffold/package-github/?output_format=md#global-parameters)󠁿

 These [global parameters](https://make.wordpress.org/cli/handbook/config/) 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._