{"id":13566675,"url":"https://github.com/wp-cli/handbook","last_synced_at":"2025-06-12T04:40:36.624Z","repository":{"id":16159144,"uuid":"79474185","full_name":"wp-cli/handbook","owner":"wp-cli","description":"📖 Complete documentation for WP-CLI","archived":false,"fork":false,"pushed_at":"2025-05-21T14:37:27.000Z","size":2006,"stargazers_count":197,"open_issues_count":23,"forks_count":342,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-05-21T15:47:53.811Z","etag":null,"topics":["cli","docs","documentation","documentations","hacktoberfest","handbook","wordpress","wp-cli"],"latest_commit_sha":null,"homepage":"https://make.wordpress.org/cli/handbook/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wp-cli.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":"governance.md","roadmap":"roadmap.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-01-19T16:52:02.000Z","updated_at":"2025-05-21T14:37:35.000Z","dependencies_parsed_at":"2023-11-06T13:37:43.576Z","dependency_job_id":"f9125839-f0bd-460e-9ad3-0542ca295efc","html_url":"https://github.com/wp-cli/handbook","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/wp-cli/handbook","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wp-cli%2Fhandbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wp-cli%2Fhandbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wp-cli%2Fhandbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wp-cli%2Fhandbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wp-cli","download_url":"https://codeload.github.com/wp-cli/handbook/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wp-cli%2Fhandbook/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259400365,"owners_count":22851798,"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":["cli","docs","documentation","documentations","hacktoberfest","handbook","wordpress","wp-cli"],"created_at":"2024-08-01T13:02:14.455Z","updated_at":"2025-06-12T04:40:36.602Z","avatar_url":"https://github.com/wp-cli.png","language":"PHP","readme":"wp-cli/handbook\n===============\n\nThese files comprise the WP-CLI handbook ([make.wordpress.org/cli/handbook](https://make.wordpress.org/cli/handbook/)) and WP-CLI commands directory ([developer.wordpress.org/cli/commands](https://developer.wordpress.org/cli/commands/)).\n\nThe documentation is located in GitHub to enable a pull request-based editing workflow.\n\nLong-form documentation (e.g. \"Commands cookbook\") can be edited directly.\n\nInternal API docs and command pages are generated dynamically from the WP-CLI codebase using the `wp handbook` series of commands.\n\nBefore running these commands the bash script `bin/install-packages.sh` should be run to install the latest versions of the non-bundled commands in `bin/packages`. Note `wp` must point to the target WP-CLI instance, i.e. the phar/git that contains the docblocks to be generated against, and should be run with `WP_CLI_PACKAGES_DIR=bin/packages` and `WP_CLI_CONFIG_PATH=/dev/null`.\n\nSo for instance to generate all dynamically created documentation against the nightly phar run:\n\n```\nwp cli update --nightly\nbin/install_packages.sh\nWP_CLI_PACKAGES_DIR=bin/packages WP_CLI_CONFIG_PATH=/dev/null wp handbook gen-all\n```\n\nAll documentation is imported automatically into WordPress.org in a two step process:\n\n1. WordPress reads `commands-manifest.json` or `handbook-manifest.json` to understand all pages that need to be created.\n2. Each WordPress page has a `markdown_source` attribute specifying a Markdown file to be fetched, converted to HTML, and saved in the database.\n\nFor make.wordpress.org/cli, the import process is a [WordPress plugin](https://meta.trac.wordpress.org/browser/sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-cli/inc/class-markdown-import.php) running a WP Cron job every 15 minutes. For developer.wordpress.org/cli, this is a [class in the devhub theme](https://meta.trac.wordpress.org/browser/sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/cli.php) running a WP Cron job every 12 hours.\n","funding_links":[],"categories":["PHP"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwp-cli%2Fhandbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwp-cli%2Fhandbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwp-cli%2Fhandbook/lists"}