pressbooks/pb-cli

A suite of wp-cli commands for Pressbooks.

3.1.0 2022-11-16 16:49 UTC

Requires

• php: ^8.0

Requires (Dev)

• wp-cli/entity-command: ^2.1
• wp-cli/extension-command: ^2.1
• wp-cli/scaffold-command: ^2.0
• wp-cli/wp-cli: ^2.5
• wp-cli/wp-cli-tests: ^3.0

GPL-3.0-or-later

README

A suite of wp-cli commands for Pressbooks.

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

Installing

Installing this package requires WP-CLI v2.5.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 [e-mail]:pressbooks/pb-cli.git

Upgrade Notice

2.1.0

• PB-CLI requires Pressbooks >= 5.21.0