{"id":41703382,"url":"https://github.com/dreamsicle-io/create-wp-theme","last_synced_at":"2026-01-24T21:04:38.782Z","repository":{"id":39700121,"uuid":"155495501","full_name":"dreamsicle-io/create-wp-theme","owner":"dreamsicle-io","description":"Create WP Theme is a node command line tool that will scaffold a new WordPress theme with an opinionated file structure and just the right amount of starter code.","archived":false,"fork":false,"pushed_at":"2025-05-15T16:21:53.000Z","size":385,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-09-29T20:55:01.634Z","etag":null,"topics":["boilerplate","code-generation","command-line-tool","nodejs","scaffolding","wordpress","wordpress-themes"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@dreamsicle.io/create-wp-theme","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dreamsicle-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-31T03:50:52.000Z","updated_at":"2025-05-15T16:19:07.000Z","dependencies_parsed_at":"2024-06-03T06:24:49.415Z","dependency_job_id":"ff9fe929-5e6a-49ad-a2f9-2eb2515ade9d","html_url":"https://github.com/dreamsicle-io/create-wp-theme","commit_stats":{"total_commits":57,"total_committers":2,"mean_commits":28.5,"dds":"0.49122807017543857","last_synced_commit":"75070e1291451a0ef246b84dc5cd98e3d52a66b5"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"purl":"pkg:github/dreamsicle-io/create-wp-theme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreamsicle-io%2Fcreate-wp-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreamsicle-io%2Fcreate-wp-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreamsicle-io%2Fcreate-wp-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreamsicle-io%2Fcreate-wp-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dreamsicle-io","download_url":"https://codeload.github.com/dreamsicle-io/create-wp-theme/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreamsicle-io%2Fcreate-wp-theme/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28736800,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-24T19:23:36.361Z","status":"ssl_error","status_checked_at":"2026-01-24T19:23:28.966Z","response_time":89,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["boilerplate","code-generation","command-line-tool","nodejs","scaffolding","wordpress","wordpress-themes"],"created_at":"2026-01-24T21:04:38.184Z","updated_at":"2026-01-24T21:04:38.776Z","avatar_url":"https://github.com/dreamsicle-io.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Create WP Theme\n\nCreate WP Theme is a node command line tool that will scaffold a new WordPress theme with an opinionated file structure and just the right amount of starter code. This package contains just the `npx @dreamsicle.io/create-wp-theme` command, all of the actual boilerplate code comes from [WP Theme Assets](https://github.com/dreamsicle-io/wp-theme-assets).\n\n## Usage\n\nOpen a terminal, `cd` to the `/path/to/wordpress/wp-content/themes` directory of a local WordPress instance, and fire the `create-wp-theme` command.\n\n```shell \nnpx @dreamsicle.io/create-wp-theme [options] \u003cdir\u003e\n```\n\n## Getting Started\n\nAll that is necessary to start using the tool is a single argument of `dir`, which corresponds to a kebab-cased string that will serve as the theme directory, the WordPress text-domain, and the package name.\n\n### 1. Run the `create-wp-theme` command\n\n```shell\nnpx @dreamsicle.io/create-wp-theme my-theme\n```\n\n\u003e **Note:** Change `my-theme` to the desired theme directory/text-domain.\n\n### 2. Follow the prompts\n\nOnce the command has been run, and the tool finds that the directory is unique, The tool will walk through a set of prompts that can be filled out inorder to customize the output of the package. \n\n```\n⚡ Let's get started ― This tool will guide you through configuring your theme.\nFor each prompt, set a value and hit \"ENTER\" to continue. To exit early, hit\n\"CMD+C\" on Mac, or \"CTRL+C\" on Windows. For help, run the command with the \"-h\"\nor \"--help\" flags to output the tool's help information. If you need to log or\nview issues, visit https://github.com/dreamsicle-io/create-wp-theme/issues.\n\nTheme Name: (My Theme)\nTemplate: ()\nTheme URI: (https://github.com/example/my-theme)\nTheme Bugs URI: (https://github.com/example/my-theme/issues)\nTheme Repository URI: (https://github.com/example/my-theme.git)\nTheme Repository SSH: ()\nTheme Repository Type: (git)\nDescription: (This theme was generated using create-wp-theme.)\nAuthor: (Example, INC.)\nAuthor Email: (hello@example.com)\nAuthor URI: (https://www.example.com)\nLicense: (UNLICENSED)\nTags: (accessibility-ready,translation-ready)\nWP Version Required: (6.0.0)\nWP Version Tested: (6.0.0)\nFunction Prefix: (my_theme)\nClass Prefix: (My_Theme)\nConstant Prefix: (MY_THEME)\nWP Engine Environment: (mythemedev)\n```\n\n\u003e **Note:** Any promptable options that have values already provided by the user will not be prompted for. If the tool detects that all possible option values have already been provided by the user, it won't display the prompt, and will instead jump directly into creation.\n\n## Logging\n\nThe tool will log its progress and errors in the console, exiting on completion and fatal errors.\n\n```\n👍 Got it! ― Creating \"WP Theme\" in tests\\wp-theme\n\n⏳ Cloning package ― https://github.com/dreamsicle-io/wp-theme-assets.git (master)\n📥 Package cloned ― 56 files cloned\n🔨 Package written ― package.json\n🔨 Files built ― 4 files renamed, 21 files built\n⏳ Fetching license ― Fetching license for SPDX ID: \"gpl-3.0\"\n📥 License fetched ― GNU General Public License v3.0\n📄 License written ― LICENSE\n📚 Theme relocated ― tests\\wp-theme\n📁 Repo initialized ― Repo type: \"git\"\n🔗 Remote repo added ― git@github.com:example/wp-theme.git\n💾 Initial files committed ― [main (root-commit) 37be1d1] ― 56 files changed, 4276 insertions(+)\n\n🚀 Theme created ― Created \"WP Theme\" in tests\\wp-theme\n\n⚡ What's next? ― Head over to your new theme directory to install dependencies\nand start cooking something up! If we've initialized a repository for you, we\ncommited the initial files and added a remote origin, but we didn't push\nupstream. It's also a good idea to check your LICENSE file to fill out any\nplaceholders that may be in the text. Now, go build something beautiful.\n\n\u003e ― cd tests/wp-theme\n\u003e ― nvm use\n\u003e ― npm install\n\u003e ― npm start\n```\n\n## Options\n\nThe tool offers several options that will serve as defaults for the tool's prompt. These options can be used to customize the default options of the tool allowing the developer to go through the prompts faster. Options provided via the CLI will not be prompted for in the terminal. To see a list of all available options and their aliases, jump to the [Help](#help) section.\n\n```shell \nnpx @dreamsicle.io/create-wp-theme -A Dreamsicle -E hello@dreamsicle.com -u https://www.dreamsicle.com my-theme\n```\n\n\u003e **Note:** If the option value has spaces in it, wrap it in quotes. For example - `\"Example, INC.\"`.\n\n**The above would set the following options:**\n\n```\nthemeAuthor:      Dreamsicle\nthemeAuthorEmail: hello@dreamsicle.com\nthemeAuthorURI:   https://www.dreamsicle.com\n```\n\n## File Generation\n\nThe tool will rename files and generate file contents if it detects placeholders in the supported [WP Theme Assets](https://github.com/dreamsicle-io/wp-theme-assets) files. Note that casing will be adjusted automatically to ensure proper conventions.\n\n### File Content Replacement\n\n| Placeholder        | Replacement              | Description                                  |\n| -----------        | ------------------------ | -------------------------------------------- | \n| `WP Theme`         | `-N`, `--themeName`      | The unmodified theme name option.            |\n| `wp_theme`         | `-F`, `--functionPrefix` | The snake-cased function prefix option.      |\n| `WP_THEME`         | `-c`, `--constantPrefix` | The constant-cased constant prefix option.   |\n| `WP_Theme`         | `-C`, `--classPrefix`    | The pascal-snake-cased class prefix option.  |\n| `class-wp-theme-*` | `-C`, `--classPrefix`    | The parsed class prefix option, kebab-cased. |\n| `wp-theme`         | `\u003cdir\u003e`                  | The kebab-cased directory argument.          |\n\n### File Renaming\n\n| Placeholder        | Replacement           | Description                                  |\n| ------------------ | --------------------- | -------------------------------------------- | \n| `class-wp-theme-*` | `-C`, `--classPrefix` | The parsed class prefix option, kebab-cased. |\n\n## Licenses\n\nThe tool will write a license for you, according to the [SPDX](https://spdx.org/) license identifier provided in the `-L` or `--themeLicense` option, from the [SPDX License API](https://spdx.org/licenses/). You may use any of the supported license identifiers to automatically write a license for you on theme creation.\n\nTo skip license generation, use `UNLICENSED` as the license identifier.\n\n\u003e **Note:** The SPDX license identifier is case sensitive.\n\n\u003e **Note:** Some licenses ship with placeholders for things like company name, date, etc. Make sure to inspect the `LICENSE` file and fill these out once your theme is generated.\n\n## Help\n\nTo get help with the tool and to learn more about usage and the available options, use the `--help` or `-h` flag. This will output all help information available including how to use the command, arguments, option flags, option descriptions, and option defaults.\n\n```shell\nnpx @dreamsicle.io/create-wp-theme --help\n```\n\n**The above would ouput the following help information:**\n\n```\nUsage: create-wp-theme [options] \u003cdir\u003e\n\nA command line tool for creating modern, optimized WordPress themes.\n\nArguments:\n  dir                               The name of the theme directory to create (example: \"my-theme\")\n\nOptions:\n  -V, --version                     output the version number\n  -N, --themeName \u003cstring\u003e          The theme name (default: \"WP Theme\")\n  -X, --themeVersion \u003cstring\u003e       The theme version (default: \"0.0.1\")\n  -T, --themeTemplate [string]      The parent theme if this is a child theme (default: \"\")\n  -U, --themeURI \u003cstring\u003e           The theme URI (default: \"https://github.com/example/wp-theme\")\n  -B, --themeBugsURI \u003cstring\u003e       The theme bugs URI (default: \"https://github.com/example/wp-theme/issues\")\n  -R, --themeRepoURI \u003cstring\u003e       The theme repository HTTPS URI (default: \"https://github.com/example/wp-theme.git\")\n  -S, --themeRepoSSH [string]       The theme repository SSH URI (default: \"\")\n  -r, --themeRepoType \u003cstring\u003e      The theme repository type (default: \"git\")\n  -D, --themeDescription \u003cstring\u003e   The theme description (default: \"This theme was generated using create-wp-theme.\")\n  -A, --themeAuthor \u003cstring\u003e        The theme author (default: \"Example, INC.\")\n  -E, --themeAuthorEmail \u003cstring\u003e   The theme author email (default: \"hello@example.com\")\n  -u, --themeAuthorURI \u003cstring\u003e     The theme author URI (default: \"https://www.example.com\")\n  -L, --themeLicense \u003cstring\u003e       The theme license as a valid SPDX expression (default: \"UNLICENSED\")\n  -t, --themeTags [string]          A CSV of WordPress theme tags (default: \"accessibility-ready,translation-ready\")\n  -W, --wpVersionRequired \u003cstring\u003e  The version of WordPress the theme requires (default: \"6.0.0\")\n  -w, --wpVersionTested \u003cstring\u003e    The version of WordPress the theme has been tested up to (default: \"6.0.0\")\n  -F, --functionPrefix \u003cstring\u003e     The prefix for PHP functions (default: \"wp_theme\")\n  -C, --classPrefix \u003cstring\u003e        The prefix for PHP classes (default: \"WP_Theme\")\n  -c, --constantPrefix \u003cstring\u003e     The prefix for PHP constants (default: \"WP_THEME\")\n  -e, --wpEngineEnv \u003cstring\u003e        The name of the WP Engine environment to deploy to (default: \"wpthemedev\")\n  -P, --path \u003cstring\u003e               The path where the built theme directory will be placed (default: \"C:\\\\path\\\\to\\\\theme\")\n  -f, --failExternals [boolean]     Exit on errors from external calls like license fetching and git initializations (default: false)\n  -v, --verbose [boolean]           Output extra information to the console (default: false)\n  -h, --help                        display help for command\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdreamsicle-io%2Fcreate-wp-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdreamsicle-io%2Fcreate-wp-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdreamsicle-io%2Fcreate-wp-theme/lists"}