{"id":28619607,"url":"https://github.com/wp-cli/wp-cli-dev","last_synced_at":"2025-06-12T04:40:38.810Z","repository":{"id":33914222,"uuid":"147706405","full_name":"wp-cli/wp-cli-dev","owner":"wp-cli","description":"🛠 WP-CLI development environment that allows for easy development across all packages","archived":false,"fork":false,"pushed_at":"2025-05-16T09:44:13.000Z","size":157,"stargazers_count":39,"open_issues_count":3,"forks_count":38,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-05-16T10:41:54.947Z","etag":null,"topics":["development","development-environment","environment","hacktoberfest","local","wp-cli"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wp-cli.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-09-06T17:03:37.000Z","updated_at":"2025-05-16T09:44:17.000Z","dependencies_parsed_at":"2023-02-15T11:40:50.028Z","dependency_job_id":"86bbeea1-f8d2-4c30-a383-71ad935ba4ef","html_url":"https://github.com/wp-cli/wp-cli-dev","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/wp-cli/wp-cli-dev","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wp-cli%2Fwp-cli-dev","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wp-cli%2Fwp-cli-dev/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wp-cli%2Fwp-cli-dev/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wp-cli%2Fwp-cli-dev/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wp-cli","download_url":"https://codeload.github.com/wp-cli/wp-cli-dev/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wp-cli%2Fwp-cli-dev/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259400380,"owners_count":22851801,"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":["development","development-environment","environment","hacktoberfest","local","wp-cli"],"created_at":"2025-06-12T04:40:38.224Z","updated_at":"2025-06-12T04:40:38.799Z","avatar_url":"https://github.com/wp-cli.png","language":"PHP","readme":"wp-cli/wp-cli-dev\n=================\n\nSets up a WP-CLI development environment that allows for easy development across all packages.\n\nThis allows easy development across all packages and contains additional maintenance commands that simplify repository chores and the release process.\n\n\n\nQuick links: [Installation](#installation) | [Development](#development) | [Using](#using) | [Contributing](#contributing) | [Support](#support)\n\n## Installation\n\nIf you normally use WP-CLI on your web host or via Brew, you're most likely using the Phar executable (`wp-cli.phar`). This Phar executable file is the \"built\", singular version of WP-CLI. It is compiled from a couple dozen repositories in the WP-CLI GitHub organization.\n\nIn order to make code changes to WP-CLI, you'll need to set up this `wp-cli-dev` development environment on your local machine. The setup process will:\n\n1. Clone all relevant packages from the `wp-cli` GitHub organization into the `wp-cli-dev` folder, and\n2. Install all Composer dependencies for a complete `wp-cli-bundle` setup, while symlinking all of the previously cloned packages into the Composer `vendor` folder.\n3. Symlink all folder in `vendor` into corresponding `vendor` folders in each repository, thus making the centralized functionality based on Composer available in each repository subfolder.\n\nBefore you can proceed further, you'll need to make sure you have [Composer](https://getcomposer.org/), PHP, and a [functioning MySQL or MariaDB server on your local machine](https://github.com/wp-cli/wp-cli-tests?tab=readme-ov-file#the-database-credentials).\n\nOnce the prerequisites are met, clone the GitHub repository and run the installation process:\n\n```bash\ngit clone https://github.com/wp-cli/wp-cli-dev wp-cli-dev\ncd wp-cli-dev\ncomposer install\ncomposer prepare-tests\n```\n\n## Development\n\nEvery subfolder is a proper clone of the corresponding GitHub repository. This means that you can create new branches, make your changes, commit to the new branch and then submit as pull-request, all from within these folders.\n\nUnless you have commit access to the repository, you'll need to fork the repository in order to push your feature branch. [GitHub's CLI](https://github.com/cli/cli) is pretty helpful for this:\n\n```bash\ncd core-command\ngh repo fork\n```\n\nAs the folders are also symlinked into the Composer `vendor` folder, you will always have the latest changes available when running WP-CLI through the `vendor/bin/wp` executable.\n\n## Using\n\nThis package implements the following commands:\n\n### wp maintenance\n\nProvides tools to manage the WP-CLI GitHub organization and the release process.\n\n~~~\nwp maintenance\n~~~\n\n\n\n\n\n### wp maintenance contrib-list\n\nLists all contributors to this release.\n\n~~~\nwp maintenance contrib-list [\u003crepo\u003e] [\u003cmilestone\u003e...] [--format=\u003cformat\u003e]\n~~~\n\nRun within the main WP-CLI project repository.\n\n**OPTIONS**\n\n\t[\u003crepo\u003e]\n\t\tName of the repository to fetch the release notes for. If no user/org\n\t\twas provided, 'wp-cli' org is assumed. If no repo is passed, release\n\t\tnotes for the entire org state since the last bundle release are fetched.\n\n\t[\u003cmilestone\u003e...]\n\t\tName of one or more milestones to fetch the release notes for. If none\n\t\tare passed, the current open one is assumed.\n\n\t[--format=\u003cformat\u003e]\n\t\tRender output in a specific format.\n\t\t---\n\t\tdefault: markdown\n\t\toptions:\n\t\t  - markdown\n\t\t  - html\n\t\t---\n\n\n\n### wp maintenance milestones-after\n\nRetrieves the milestones that were closed after a given milestone.\n\n~~~\nwp maintenance milestones-after \u003crepo\u003e \u003cmilestone\u003e\n~~~\n\n**OPTIONS**\n\n\t\u003crepo\u003e\n\t\tName of the repository to fetch the milestones for.\n\n\t\u003cmilestone\u003e\n\t\tMilestone to serve as treshold.\n\n\n\n### wp maintenance milestones-since\n\nRetrieves the milestones that were closed for a given repository after a\n\n~~~\nwp maintenance milestones-since \u003crepo\u003e \u003cdate\u003e\n~~~\n\nspecific date treshold.\n\n**OPTIONS**\n\n\t\u003crepo\u003e\n\t\tName of the repository to fetch the milestones for.\n\n\t\u003cdate\u003e\n\t\tThreshold date to filter by.\n\n\n\n### wp maintenance release-date\n\nRetrieves the date a given release for a repository was published at.\n\n~~~\nwp maintenance release-date \u003crepo\u003e \u003crelease\u003e\n~~~\n\n**OPTIONS**\n\n\t\u003crepo\u003e\n\t\tName of the repository to fetch the release notes for. If no user/org\n\t\twas provided, 'wp-cli' org is assumed.\n\n\t\u003crelease\u003e\n\t\tName of the release to fetch the release notes for.\n\n\n\n### wp maintenance release-notes\n\nGets the release notes for one or more milestones of a repository.\n\n~~~\nwp maintenance release-notes [\u003crepo\u003e] [\u003cmilestone\u003e...] [--source=\u003csource\u003e] [--format=\u003cformat\u003e]\n~~~\n\n**OPTIONS**\n\n\t[\u003crepo\u003e]\n\t\tName of the repository to fetch the release notes for. If no user/org\n\t\twas provided, 'wp-cli' org is assumed. If no repo is passed, release\n\t\tnotes for the entire org state since the last bundle release are fetched.\n\n\t[\u003cmilestone\u003e...]\n\t\tName of one or more milestones to fetch the release notes for. If none\n\t\tare passed, the current open one is assumed.\n\n\t[--source=\u003csource\u003e]\n\t\tChoose source from where to copy content.\n\t\t---\n\t\tdefault: release\n\t\toptions:\n\t\t  - release\n\t\t  - pull-request\n\n\t[--format=\u003cformat\u003e]\n\t\tRender output in a specific format.\n\t\t---\n\t\tdefault: markdown\n\t\toptions:\n\t\t  - markdown\n\t\t  - html\n\t\t---\n\n\n\n### wp maintenance replace-label\n\nReplaces a label with a different one, and optionally deletes the old\n\n~~~\nwp maintenance replace-label \u003crepo\u003e \u003cold-label\u003e \u003cnew-label\u003e [--delete]\n~~~\n\nlabel.\n\n**OPTIONS**\n\n\t\u003crepo\u003e\n\t\tName of the repository you want to replace a label for.\n\n\t\u003cold-label\u003e\n\t\tOld label to replace on all issues.\n\n\t\u003cnew-label\u003e\n\t\tNew label to replace it with.\n\n\t[--delete]\n\t\tDelete the old label after the operation is complete.\n\n## Contributing\n\nWe appreciate you taking the initiative to contribute to this project.\n\nContributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.\n\nFor a more thorough introduction, [check out WP-CLI's guide to contributing](https://make.wordpress.org/cli/handbook/contributing/). This package follows those policy and guidelines.\n\n### Reporting a bug\n\nThink you’ve found a bug? We’d love for you to help us get it fixed.\n\nBefore you create a new issue, you should [search existing issues](https://github.com/wp-cli/wp-cli-dev/issues?q=label%3Abug%20) to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.\n\nOnce you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please [create a new issue](https://github.com/wp-cli/wp-cli-dev/issues/new). Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, [review our bug report documentation](https://make.wordpress.org/cli/handbook/bug-reports/).\n\n### Creating a pull request\n\nWant to contribute a new feature? Please first [open a new issue](https://github.com/wp-cli/wp-cli-dev/issues/new) to discuss whether the feature is a good fit for the project.\n\nOnce you've decided to commit the time to seeing your pull request through, [please follow our guidelines for creating a pull request](https://make.wordpress.org/cli/handbook/pull-requests/) to make sure it's a pleasant experience. See \"[Setting up](https://make.wordpress.org/cli/handbook/pull-requests/#setting-up)\" for details specific to working on this package locally.\n\n## Support\n\nGitHub issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwp-cli%2Fwp-cli-dev","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwp-cli%2Fwp-cli-dev","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwp-cli%2Fwp-cli-dev/lists"}