Skip to content

A little CLI which helps to generate/update/remove parts of code in our WP theme

License

Notifications You must be signed in to change notification settings

tysian/wp-theme-cli

Repository files navigation

WP Theme CLI

Goal

Bootstrapping new WP projects might be time consuming. I've decided to create this CLI to automate some of tasks.
For now, I'm focusing on files operations, such as removing unnecessary files or creating new ones.

Warning

This package is still in beta, and some of features are about removing or modifying files.
Please, make sure that you are in correct folder and you are using version control system (eg. git).
You are using this tool for your own responsibility.

Requirements

  • Node 14.18.0 or >=16.12.0

Installation

Preferred way is to run latest version directly using npx or pnpx

npx wp-theme-cli@latest
pnpx wp-theme-cli@latest

You can also install it locally or globally, but this way is NOT RECOMMENDED.

Available options

Check all commands available using help command

wp-theme-cli --help

Each feature is called a module and have separate documentation:

  1. ACF Generator - Generate files based on flexible field layouts
  2. Cleaner - Remove directories, files, update files by removing lines of code, update JSON files (cleaner)
  3. Create style.css - Create style.css WP meta file using package.json

Credits

All npm/husky/changeset/commitlint related stuff, typescript building setup was inspired by create-t3-app.

About

A little CLI which helps to generate/update/remove parts of code in our WP theme

Resources

License

Stars

Watchers

Forks

Packages

No packages published