Skip to content
A suite of wp-cli commands for Pressbooks.
PHP HTML Gherkin CSS Shell JavaScript
Branch: dev
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
.vuepress
bin
docs
features
inc
templates
utils
.editorconfig
.gitignore
.travis.yml
LICENSE.md
README.md
command.php
composer.json
composer.lock
package-lock.json
package.json
wp-cli.yml

README.md

pressbooks/pb-cli

A suite of wp-cli commands for Pressbooks.

Build Status

Quick links: Using | Installing | Contributing | Support

Using

This package implements the following commands:

wp scaffold book-theme

Generate the files needed for a Pressbooks book theme.

wp scaffold book-theme <slug> <vendor> [--theme_name=<title>] [--description=<description>] [--uri=<uri>] [--author=<author>] [--author_uri=<author_uri>] [--github_account=<github_account>] [--github_repo=<github_repo>] [--license=<license>] [--textdomain=<textdomain>] [--version=<version>] [--dir=<dir>] [--activate] [--enable-network] [--force]

Default behavior is to create the following files:

  • functions.php
  • .gitignore, .editorconfig, package.json, composer.json, composer.lock, yarn.lock
  • README.md

Unless specified with --dir=<dir>, the theme is placed in the themes directory.

OPTIONS

<slug>
	Slug for the new theme.

<vendor>
	Vendor for the new theme. Used in composer.json and package.json.

[--theme_name=<title>]
	What to put in the 'Theme Name:' header in 'style.css'. Defaults to <slug>.

[--description=<description>]
	Human-readable description for the theme.

[--uri=<uri>]
	What to put in the 'Theme URI:' header in 'style.css'.

[--author=<author>]
	What to put in the 'Author:' header in 'style.css'.

[--author_uri=<author_uri>]
	What to put in the 'Author URI:' header in 'style.css'.

[--github_account=<github_account>]
	The GitHub account that owns this project (e.g. 'pressbooks'). Defaults to vendor.

[--github_repo=<github_repo>]
	The GitHub repo name for this project (e.g. 'pressbooks-book'). Defaults to slug.

[--license=<license>]
	What to put in the 'License:' header in 'style.css'.
	---
	default: GPL 2.0+
	---

[--textdomain=<textdomain>]
	Text domain for the theme. Defaults to <slug>.

[--version=<version>]
	Version for the theme.
	---
	default: 1.0
	---

[--dir=<dir>]
	Specify a destination directory for the command. Defaults to the themes directory.

[--activate]
	Activate the newly created book theme.

[--enable-network]
	Enable the newly created book theme for the entire network.

[--force]
	Overwrite files that already exist.

wp pb issue-template

Generate an issue template for a Pressbooks theme or plugin, placing it in .github/ISSUE_TEMPLATE.md.

wp pb issue-template <slug> --type=<type> --owner=<owner> [--dir=<dir>] [--force]

OPTIONS

<slug>
	Slug for the theme or plugin (e.g. pressbooks, pressbooks-book).

--type=<type>
	The type of repo for which we're generating an issue template. Must be `theme` or `plugin`.

--owner=<owner>
	The GitHub username of this repo's owner (e.g. pressbooks).

[--dir=<dir>]
	Specify a destination directory for the command. Defaults to the theme or plugin's directory.

[--force]
	Overwrite files that already exist.

wp pb theme lock

Lock a book's theme.

wp pb theme lock --url=<url>

OPTIONS

--url=<url>
	The URL of the target book.

wp pb theme unlock

Unlock a book's theme.

wp pb theme unlock --url=<url>

OPTIONS

--url=<url>
	The URL of the target book.

wp pb clone

Clone a book.

wp pb clone <source> <destination> --user=<user>

OPTIONS

<source>
	URL

<destination>
	Book slug on the current network

--user=<user>
	sets request to a specific WordPress user

wp pb make-pot

Create a POT file for a WordPress project. Adds support for .blade.php templates.

Run the following command in the plugin directory from your development environment:

 wp pb make-pot . languages/<plugin>.pot --exclude="vendor,symbionts" --headers='{"Report-Msgid-Bugs-To":"https://github.com/pressbooks/<plugin>/"}'

Same options as: https://github.com/wp-cli/i18n-command#wp-i18n-make-pot

Installing

Installing this package requires WP-CLI v2.1.0 or greater. Update to the latest stable release with wp cli update.

Once you've done so, you can install this package with:

wp package install git@github.com:pressbooks/pb-cli.git

Upgrade Notice

2.0.1

  • PB-CLI requires Pressbooks >= 5.7.0
You can’t perform that action at this time.