PHPackages                             wp-cli/scaffold-package-command - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI & Console](/categories/cli)
4. /
5. wp-cli/scaffold-package-command

ActiveWp-cli-package[CLI & Console](/categories/cli)

wp-cli/scaffold-package-command
===============================

Scaffolds WP-CLI commands with functional tests, full README.md, and more.

v2.2.3(2mo ago)70121.3k↑190.5%20[1 issues](https://github.com/wp-cli/scaffold-package-command/issues)3MITGherkinPHP >=7.2.24CI passing

Since Sep 8Pushed 2mo ago5 watchersCompare

[ Source](https://github.com/wp-cli/scaffold-package-command)[ Packagist](https://packagist.org/packages/wp-cli/scaffold-package-command)[ Docs](https://github.com/wp-cli/scaffold-package-command)[ RSS](/packages/wp-cli-scaffold-package-command/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (8)Versions (22)Used By (3)

wp-cli/scaffold-package-command
===============================

[](#wp-cliscaffold-package-command)

Scaffolds WP-CLI commands with functional tests, full README.md, and more.

[![Testing](https://github.com/wp-cli/scaffold-package-command/actions/workflows/testing.yml/badge.svg)](https://github.com/wp-cli/scaffold-package-command/actions/workflows/testing.yml) [![CircleCI](https://camo.githubusercontent.com/0198895af68d789e918264b881b317b3c36956ca5947a9b09d62b8262f0cba52/68747470733a2f2f636972636c6563692e636f6d2f67682f77702d636c692f73636166666f6c642d7061636b6167652d636f6d6d616e642f747265652f6d61696e2e7376673f7374796c653d737667)](https://circleci.com/gh/wp-cli/scaffold-package-command/tree/main)

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

Using
-----

[](#using)

This package implements the following commands:

### wp scaffold package

[](#wp-scaffold-package)

Generate the files needed for a basic WP-CLI command.

```
wp scaffold package  [--description=] [--homepage=] [--dir=] [--license=] [--require_wp_cli=] [--require_wp_cli_tests=] [--skip-tests] [--skip-readme] [--skip-github] [--skip-install] [--force]

```

Default behavior is to create the following files:

- command.php
- composer.json (with package name, description, and license)
- LICENSE
- .gitignore, .editorconfig, .distignore, and phpcs.xml.dist
- README.md (via wp scaffold package-readme)
- Test harness (via wp scaffold package-tests)

Unless specified with `--dir=`, the command package is placed in the WP-CLI `packages/local/` directory.

**OPTIONS**

```

	Name for the new package. Expects / (e.g. 'wp-cli/scaffold-package').

[--description=]
	Human-readable description for the package.

[--homepage=]
	Homepage for the package. Defaults to 'https://github.com/'

[--dir=]
	Specify a destination directory for the command. Defaults to WP-CLI's `packages/local/` directory.

[--license=]
	License for the package.
	---
	default: MIT
	---

[--require_wp_cli=]
	Required WP-CLI version for the package.
	---
	default: ^2.13
	---

[--require_wp_cli_tests=]
	Required WP-CLI testing framework version for the package.
	---
	default: ^5.0.0
	---

[--skip-tests]
	Don't generate files for integration testing.

[--skip-readme]
	Don't generate a README.md for the package.

[--skip-github]
	Don't generate GitHub issue and pull request templates.

[--skip-install]
	Don't install the package after scaffolding.

[--force]
	Overwrite files that already exist.

```

### wp scaffold package-tests

[](#wp-scaffold-package-tests)

Generate files for writing Behat tests for your command.

```
wp scaffold package-tests  [--ci=] [--force]

```

WP-CLI makes use of a Behat-based testing framework, which you should use too. This command generates all of the files you need. Functional tests are an integral ingredient of high-quality, maintainable commands. Behat is a great choice as a testing framework because:

- It’s easy to write new tests, which means they’ll actually get written.
- The tests interface with your command in the same manner as your users interface with your command, and they describe how the command is expected to work in human-readable terms.

Behat tests live in the `features/` directory of your project. When you use this command, it will generate a default test that looks like this:

```
Feature: Test that WP-CLI loads.

  Scenario: WP-CLI loads for your tests
    Given a WP install

    When I run `wp eval 'echo "Hello world.";'`
    Then STDOUT should contain:
      """
      Hello world.
      """

```

Functional tests typically follow this pattern:

- **Given** some background,
- **When** a user performs a specific action,
- **Then** the end result should be X (and Y and Z).

View all defined Behat steps available for use with `behat -dl`:

```
Given /^an empty directory$/
Given /^an empty cache/
Given /^an? ([^\s]+) file:$/
Given /^"([^"]+)" replaced with "([^"]+)" in the ([^\s]+) file$/

```

The files generated by this command include:

- `.travis.yml` is the configuration file for Travis CI.
- `bin/install-package-tests.sh` will configure your environment to run the tests.
- `bin/test.sh` is a test runner that respects contextual Behat tags.
- `features/load-wp-cli.feature` is a basic test to confirm WP-CLI can load.
- `features/bootstrap`, `features/steps`, `features/extra` are Behat configuration files.

After running `bin/install-package-tests.sh`, you can run the tests with `./vendor/bin/behat`. If you find yourself using Behat on a number of projects and don't want to install a copy with each one, you can `composer global require behat/behat` to install Behat globally on your machine. Make sure `~/.composer/vendor/bin` has also been added to your `$PATH`. Once you've done so, you can run the tests for a project by calling `behat`.

For Travis CI, specially-named files in the package directory can be used to modify the generated `.travis.yml`, where `` is one of 'cache', 'env', 'matrix', 'before\_install', 'install', 'before\_script', 'script':

- `travis-.yml` - contents used for `:` (if present following ignored)
- `travis--append.yml` - contents appended to generated `:`

You can also append to the generated `.travis.yml` with the file:

- `travis-append.yml` - contents appended to generated `.travis.yml`

**ENVIRONMENT**

The `features/bootstrap/FeatureContext.php` file expects the WP\_CLI\_BIN\_DIR environment variable.

WP-CLI Behat framework uses Behat ~2.5, which is installed with Composer.

**OPTIONS**

```

	Directory path to an existing package to generate tests for.

[--ci=]
	Create a configuration file for a specific CI provider.
	---
	default: travis
	options:
	  - travis
	  - circle
	  - github
	---

[--force]
	Overwrite files that already exist.

```

**EXAMPLES**

```
# Generate files for writing Behat tests.
$ wp scaffold package-tests /path/to/command/dir/
Success: Created package test files.

```

### wp scaffold package-readme

[](#wp-scaffold-package-readme)

Generate a README.md for your command.

```
wp scaffold package-readme  [--force] [--branch=] [--license=]

```

Creates a README.md with Using, Installing, and Contributing instructions based on the composer.json file for your WP-CLI package. Run this command at the beginning of your project, and then every time your usage docs change.

These command-specific docs are generated based composer.json -> 'extra' -> 'commands'. For instance, this package's composer.json includes:

```
{
  "name": "wp-cli/scaffold-package-command",
   // [...]
   "extra": {
       "commands": [
           "scaffold package",
           "scaffold package-tests",
           "scaffold package-readme"
       ]
   }
}

```

You can also customize the rendering of README.md generally with composer.json -> 'extra' -> 'readme'. For example, runcommand/hook's composer.json includes:

```
{
    "extra": {
        "commands": [
            "hook"
        ],
        "readme": {
            "shields": [
                "[![Build Status](https://travis-ci.org/runcommand/reset-password.svg?branch=main)](https://travis-ci.org/runcommand/reset-password)"
            ],
            "sections": [
                "Using",
                "Installing",
                "Support"
            ],
            "support": {
                "body": "https://raw.githubusercontent.com/runcommand/runcommand-theme/main/bin/readme-partials/support-open-source.md"
            },
            "show_powered_by": false
        }
    }
}

```

In this example:

- "shields" supports arbitrary images as shields to display.
- "sections" permits defining arbitrary sections (instead of default Using, Installing and Contributing).
- "support" -> "body" uses a remote Markdown file as the section contents. This can also be a local file path, or a string.
- "show\_powered\_by" shows or hides the Powered By mention at the end of the readme.

For sections, "pre", "body" and "post" are supported. Example:

```
"support": {
  "pre": "highlight.md",
  "body": "https://raw.githubusercontent.com/runcommand/runcommand-theme/main/bin/readme-partials/support-open-source.md",
  "post": "This is additional text to show after main body content."
},

```

In this example:

- "pre" content is pulled from local highlight.md file.
- "body" content is pulled from remote URL.
- "post" is a string.

**OPTIONS**

```

	Directory path to an existing package to generate a readme for.

[--force]
	Overwrite the readme if it already exists.

[--branch=]
	Name of default branch of the underlying repository. Defaults to main.

[--license=]
	License for the package.
	---
	default: MIT
	---

```

### wp scaffold package-github

[](#wp-scaffold-package-github)

Generate GitHub configuration files for your command.

```
wp scaffold package-github  [--force]

```

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/).

**OPTIONS**

```

	Directory path to an existing package to generate GitHub configuration for.

[--force]
	Overwrite files that already exist.

```

Installing
----------

[](#installing)

Installing this package requires WP-CLI v2.13 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:

```
wp package install wp-cli/scaffold-package-command:@stable

```

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

```
wp package install wp-cli/scaffold-package-command:dev-main

```

Contributing
------------

[](#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

[](#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/wp-cli/scaffold-package-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/wp-cli/scaffold-package-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

[](#creating-a-pull-request)

Want to contribute a new feature? Please first [open a new issue](https://github.com/wp-cli/scaffold-package-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.

### License

[](#license)

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

Support
-------

[](#support)

GitHub issues aren't for general support questions, but there are other venues you can try:

*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.*

###  Health Score

61

—

FairBetter than 99% of packages

Maintenance87

Actively maintained with recent releases

Popularity48

Moderate usage in the ecosystem

Community29

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor1

Top contributor holds 50% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~230 days

Recently: every ~169 days

Total

16

Last Release

60d ago

Major Versions

v0.5.0 → v2.0.02021-05-10

PHP version history (2 changes)v2.0.0PHP ^5.6 || ^7 || ^8

v2.2.0PHP >=7.2.24

### Community

Maintainers

![](https://www.gravatar.com/avatar/6dde7f578e5530884238e7173f768ae3a890b6d66eb99262a82f2c494a1b67d4?d=identicon)[schlessera](/maintainers/schlessera)

---

Top Contributors

[![danielbachhuber](https://avatars.githubusercontent.com/u/36432?v=4)](https://github.com/danielbachhuber "danielbachhuber (290 commits)")[![schlessera](https://avatars.githubusercontent.com/u/83631?v=4)](https://github.com/schlessera "schlessera (116 commits)")[![swissspidy](https://avatars.githubusercontent.com/u/841956?v=4)](https://github.com/swissspidy "swissspidy (61 commits)")[![gitlost](https://avatars.githubusercontent.com/u/481982?v=4)](https://github.com/gitlost "gitlost (26 commits)")[![haroldangenent](https://avatars.githubusercontent.com/u/1481468?v=4)](https://github.com/haroldangenent "haroldangenent (18 commits)")[![Copilot](https://avatars.githubusercontent.com/in/1143301?v=4)](https://github.com/Copilot "Copilot (16 commits)")[![ernilambar](https://avatars.githubusercontent.com/u/2098823?v=4)](https://github.com/ernilambar "ernilambar (11 commits)")[![aaemnnosttv](https://avatars.githubusercontent.com/u/1621608?v=4)](https://github.com/aaemnnosttv "aaemnnosttv (9 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (8 commits)")[![miya0001](https://avatars.githubusercontent.com/u/309946?v=4)](https://github.com/miya0001 "miya0001 (6 commits)")[![Lewiscowles1986](https://avatars.githubusercontent.com/u/2605791?v=4)](https://github.com/Lewiscowles1986 "Lewiscowles1986 (4 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (3 commits)")[![johnbillion](https://avatars.githubusercontent.com/u/208434?v=4)](https://github.com/johnbillion "johnbillion (3 commits)")[![mrsdizzie](https://avatars.githubusercontent.com/u/1669571?v=4)](https://github.com/mrsdizzie "mrsdizzie (2 commits)")[![pattonwebz](https://avatars.githubusercontent.com/u/3902039?v=4)](https://github.com/pattonwebz "pattonwebz (2 commits)")[![ntwb](https://avatars.githubusercontent.com/u/1016458?v=4)](https://github.com/ntwb "ntwb (2 commits)")[![wojsmol](https://avatars.githubusercontent.com/u/4176111?v=4)](https://github.com/wojsmol "wojsmol (2 commits)")[![Mte90](https://avatars.githubusercontent.com/u/403283?v=4)](https://github.com/Mte90 "Mte90 (1 commits)")

---

Tags

clihacktoberfestpackagescaffoldtemplatewordpresswp-cliwp-cli-package

### Embed Badge

![Health badge](/badges/wp-cli-scaffold-package-command/health.svg)

```
[![Health](https://phpackages.com/badges/wp-cli-scaffold-package-command/health.svg)](https://phpackages.com/packages/wp-cli-scaffold-package-command)
```

###  Alternatives

[wp-cli/entity-command

Manage WordPress comments, menus, options, posts, sites, terms, and users.

1048.8M55](/packages/wp-cli-entity-command)[wp-cli/wp-cli-bundle

WP-CLI bundle package with default commands.

896.3M131](/packages/wp-cli-wp-cli-bundle)[wp-cli/scaffold-command

Generates code for post types, taxonomies, blocks, plugins, child themes, etc.

1717.7M15](/packages/wp-cli-scaffold-command)[wp-cli/i18n-command

Provides internationalization tools for WordPress projects.

11610.4M52](/packages/wp-cli-i18n-command)[wp-cli/extension-command

Manages plugins and themes, including installs, activations, and updates.

919.0M53](/packages/wp-cli-extension-command)[wp-cli/db-command

Performs basic database operations using credentials stored in wp-config.php.

768.0M30](/packages/wp-cli-db-command)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)