{"repo":"wp-cli/handbook","free":true,"listed":false,"github":"https://github.com/wp-cli/handbook","clone":"git clone https://github.com/wp-cli/handbook.git","description":"📖 Complete documentation for WP-CLI","language":"PHP","stars":204,"topics":["wp-cli","documentation","wordpress","cli","handbook","documentations","docs","hacktoberfest"],"license":"MIT","category":"cli-tools","readme_excerpt":"wp-cli/handbook =============== These files comprise the WP-CLI handbook (make.wordpress.org/cli/handbook) and WP-CLI commands directory (developer.wordpress.org/cli/commands). The documentation is located in GitHub to enable a pull request-based editing workflow. Long-form documentation (e.g. \"Commands cookbook\") can be edited directly. Internal API docs and command pages are generated dynamically from the WP-CLI codebase using the wp handbook series of commands. Before 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 that wp must point to the target WP-CLI instance (i.e., the phar or git version 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 . So for instance to generate all dynamically created documentation against the nightly phar run: Automated Handbook Generation The handbook can be regenerated automatically using the \"Regenerate Handbook\" GitHub Actions workflow. This workflow can be triggered in two ways: 1. Manual trigger : Navigate to the Actions tab in the GitHub repository and run the \"Regenerate Handbook\" workflow manually. 2. Automated trigger from wp-cli/wp-cli : When a new version of WP-CLI is released, the main framework repository can trigger this workflow using a repository dispatch event with type regenerate-handbook . The workflow will: - Install WP-CLI","default_branch":null,"files":null,"tree":[],"storefront":"/r/wp-cli","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/wp-cli/handbook/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}