underscoretw / scaffold
Generates starter themes from underscoretw.com via WP-CLI.
Package info
github.com/underscoretw/scaffold
Type:wp-cli-package
pkg:composer/underscoretw/scaffold
Requires
- wp-cli/wp-cli: ^2.12
Requires (Dev)
This package is auto-updated.
Last update: 2026-03-26 08:42:10 UTC
README
A WP-CLI package that generates starter themes from underscoretw.com.
Installation
wp package install underscoretw/scaffold:@stable
Usage
wp scaffold _tw [<slug>] [--theme_name=<title>] [--prefix=<prefix>]
[--theme_uri=<uri>] [--author=<full-name>] [--author_uri=<uri>]
[--description=<text>] [--activate] [--enable-network] [--force]
wp scaffold underscoretw is also available as an alias.
Interactive Wizard
Run the command without any arguments to launch an interactive wizard that walks you through the theme setup:
wp scaffold _tw
The wizard will prompt you for:
- Theme name (required)
- Theme slug (derived from the name by default)
- Function prefix (derived from the slug by default)
- Author, author URI, theme URI, and description (all optional)
After collecting your inputs, the wizard displays a summary and asks for confirmation before generating the theme.
Options
| Option | Description |
|---|---|
<slug> |
The slug for the new theme. If omitted, the interactive wizard is launched. |
--theme_name=<title> |
Theme name. Defaults to the slug with the first letter capitalized. |
--prefix=<prefix> |
Function prefix for the theme. Derived from the slug by default. |
--theme_uri=<uri> |
Theme URI header value. |
--author=<full-name> |
Author header value. |
--author_uri=<uri> |
Author URI header value. |
--description=<text> |
Description header value. |
--activate |
Activate the theme after generating it. |
--enable-network |
Network-enable the theme after generating it. |
--force |
Overwrite the theme directory if it already exists. |
Examples
Generate a theme using the interactive wizard:
wp scaffold _tw
Generate a theme with default settings:
wp scaffold _tw my-theme
Generate a theme with custom options:
wp scaffold _tw my-theme --theme_name="My Theme" --author="Jane Doe" --description="A custom theme"
Generate and activate:
wp scaffold _tw my-theme --theme_name="My Theme" --activate
Overwrite an existing theme:
wp scaffold _tw my-theme --force
Credits
This package began as a fork of wp-cli/scaffold-command. Its wizard was inspired by npm init.