{"id":28462239,"url":"https://github.com/pressbooks/pb-cli","last_synced_at":"2025-07-03T16:31:32.456Z","repository":{"id":10444409,"uuid":"65767481","full_name":"pressbooks/pb-cli","owner":"pressbooks","description":"A suite of wp-cli commands for Pressbooks.","archived":false,"fork":false,"pushed_at":"2025-05-15T19:40:24.000Z","size":627,"stargazers_count":5,"open_issues_count":8,"forks_count":1,"subscribers_count":10,"default_branch":"dev","last_synced_at":"2025-06-12T19:21:27.476Z","etag":null,"topics":["automation","backend","cli"],"latest_commit_sha":null,"homepage":"https://cli.pressbooks.org/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pressbooks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","funding":null,"license":"LICENSE.md","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,"zenodo":null}},"created_at":"2016-08-15T21:52:59.000Z","updated_at":"2025-03-26T13:57:10.000Z","dependencies_parsed_at":"2024-03-15T02:29:24.594Z","dependency_job_id":"7e132646-9996-4641-9756-419d8b9ec844","html_url":"https://github.com/pressbooks/pb-cli","commit_stats":{"total_commits":106,"total_committers":9,"mean_commits":"11.777777777777779","dds":0.4339622641509434,"last_synced_commit":"ad041f8cd66cf00c581e0c65ace522f877fa2f03"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"purl":"pkg:github/pressbooks/pb-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pressbooks%2Fpb-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pressbooks%2Fpb-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pressbooks%2Fpb-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pressbooks%2Fpb-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pressbooks","download_url":"https://codeload.github.com/pressbooks/pb-cli/tar.gz/refs/heads/dev","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pressbooks%2Fpb-cli/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261154804,"owners_count":23117097,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["automation","backend","cli"],"created_at":"2025-06-07T04:08:45.720Z","updated_at":"2025-07-03T16:31:32.448Z","avatar_url":"https://github.com/pressbooks.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"pressbooks/pb-cli\n=================\n\nA suite of wp-cli commands for Pressbooks.\n\n[![Build Status](https://travis-ci.org/pressbooks/pb-cli.svg?branch=production)](https://travis-ci.org/pressbooks/pb-cli)\n\nQuick links: [Using](#using) | [Installing](#installing) | [Contributing](docs/contributing.md#contributing) | [Support](docs/contributing.md#support)\n\n## Using\n\nThis package implements the following commands:\n\n### wp scaffold book-theme\n\nGenerate the files needed for a Pressbooks book theme.\n\n~~~\nwp scaffold book-theme \u003cslug\u003e \u003cvendor\u003e [--theme_name=\u003ctitle\u003e] [--description=\u003cdescription\u003e] [--uri=\u003curi\u003e] [--author=\u003cauthor\u003e] [--author_uri=\u003cauthor_uri\u003e] [--github_account=\u003cgithub_account\u003e] [--github_repo=\u003cgithub_repo\u003e] [--license=\u003clicense\u003e] [--textdomain=\u003ctextdomain\u003e] [--version=\u003cversion\u003e] [--dir=\u003cdir\u003e] [--activate] [--enable-network] [--force]\n~~~\n\nDefault behavior is to create the following files:\n- functions.php\n- .gitignore, .editorconfig, package.json, composer.json, composer.lock, yarn.lock\n- README.md\n\nUnless specified with `--dir=\u003cdir\u003e`, the theme is placed in the themes\ndirectory.\n\n**OPTIONS**\n\n\t\u003cslug\u003e\n\t\tSlug for the new theme.\n\n\t\u003cvendor\u003e\n\t\tVendor for the new theme. Used in composer.json and package.json.\n\n\t[--theme_name=\u003ctitle\u003e]\n\t\tWhat to put in the 'Theme Name:' header in 'style.css'. Defaults to \u003cslug\u003e.\n\n\t[--description=\u003cdescription\u003e]\n\t\tHuman-readable description for the theme.\n\n\t[--uri=\u003curi\u003e]\n\t\tWhat to put in the 'Theme URI:' header in 'style.css'.\n\n\t[--author=\u003cauthor\u003e]\n\t\tWhat to put in the 'Author:' header in 'style.css'.\n\n\t[--author_uri=\u003cauthor_uri\u003e]\n\t\tWhat to put in the 'Author URI:' header in 'style.css'.\n\n\t[--github_account=\u003cgithub_account\u003e]\n\t\tThe GitHub account that owns this project (e.g. 'pressbooks'). Defaults to vendor.\n\n\t[--github_repo=\u003cgithub_repo\u003e]\n\t\tThe GitHub repo name for this project (e.g. 'pressbooks-book'). Defaults to slug.\n\n\t[--license=\u003clicense\u003e]\n\t\tWhat to put in the 'License:' header in 'style.css'.\n\t\t---\n\t\tdefault: GPL 2.0+\n\t\t---\n\n\t[--textdomain=\u003ctextdomain\u003e]\n\t\tText domain for the theme. Defaults to \u003cslug\u003e.\n\n\t[--version=\u003cversion\u003e]\n\t\tVersion for the theme.\n\t\t---\n\t\tdefault: 1.0\n\t\t---\n\n\t[--dir=\u003cdir\u003e]\n\t\tSpecify a destination directory for the command. Defaults to the themes directory.\n\n\t[--activate]\n\t\tActivate the newly created book theme.\n\n\t[--enable-network]\n\t\tEnable the newly created book theme for the entire network.\n\n\t[--force]\n\t\tOverwrite files that already exist.\n\n\n\n### wp pb issue-template\n\nGenerate an issue template for a Pressbooks theme or plugin, placing it in .github/ISSUE_TEMPLATE.md.\n\n~~~\nwp pb issue-template \u003cslug\u003e --type=\u003ctype\u003e --owner=\u003cowner\u003e [--dir=\u003cdir\u003e] [--force]\n~~~\n\n**OPTIONS**\n\n\t\u003cslug\u003e\n\t\tSlug for the theme or plugin (e.g. pressbooks, pressbooks-book).\n\n\t--type=\u003ctype\u003e\n\t\tThe type of repo for which we're generating an issue template. Must be `theme` or `plugin`.\n\n\t--owner=\u003cowner\u003e\n\t\tThe GitHub username of this repo's owner (e.g. pressbooks).\n\n\t[--dir=\u003cdir\u003e]\n\t\tSpecify a destination directory for the command. Defaults to the theme or plugin's directory.\n\n\t[--force]\n\t\tOverwrite files that already exist.\n\n\n\n### wp pb theme lock\n\nLock a book's theme.\n\n~~~\nwp pb theme lock --url=\u003curl\u003e\n~~~\n\n**OPTIONS**\n\n\t--url=\u003curl\u003e\n\t\tThe URL of the target book.\n\n\n\n### wp pb theme unlock\n\nUnlock a book's theme.\n\n~~~\nwp pb theme unlock --url=\u003curl\u003e\n~~~\n\n**OPTIONS**\n\n\t--url=\u003curl\u003e\n\t\tThe URL of the target book.\n\n\n\n### wp pb clone\n\nClone a book.\n\n~~~\nwp pb clone \u003csource\u003e \u003cdestination\u003e --user=\u003cuser\u003e\n~~~\n\n**OPTIONS**\n\n\t\u003csource\u003e\n\t\tURL\n\n\t\u003cdestination\u003e\n\t\tBook slug on the current network\n\n\t--user=\u003cuser\u003e\n\t\tsets request to a specific WordPress user\n\n## Installing\n\nInstalling this package requires WP-CLI v2.5.0 or greater. Update to the latest stable release with `wp cli update`.\n\nOnce you've done so, you can install this package with:\n\n    wp package install git@github.com:pressbooks/pb-cli.git\n\n\n## Upgrade Notice\n\n\n### 2.1.0\n* PB-CLI requires Pressbooks \u003e= 5.21.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpressbooks%2Fpb-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpressbooks%2Fpb-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpressbooks%2Fpb-cli/lists"}