{"id":24263880,"url":"https://github.com/wp-cli/package-command","last_synced_at":"2025-10-04T05:39:12.647Z","repository":{"id":45041108,"uuid":"84599440","full_name":"wp-cli/package-command","owner":"wp-cli","description":"Lists, installs, and removes WP-CLI packages.","archived":false,"fork":false,"pushed_at":"2024-11-24T17:34:25.000Z","size":8719,"stargazers_count":17,"open_issues_count":11,"forks_count":20,"subscribers_count":8,"default_branch":"main","last_synced_at":"2024-12-19T21:03:04.308Z","etag":null,"topics":["cli","composer","hacktoberfest","package","package-management","wordpress","wp-cli","wp-cli-package"],"latest_commit_sha":null,"homepage":"","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":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-03-10T20:47:12.000Z","updated_at":"2024-11-24T17:34:28.000Z","dependencies_parsed_at":"2024-04-26T11:24:53.415Z","dependency_job_id":"c3b7f81d-357b-451b-9713-f76f7d78159f","html_url":"https://github.com/wp-cli/package-command","commit_stats":{"total_commits":564,"total_committers":51,"mean_commits":"11.058823529411764","dds":0.7570921985815603,"last_synced_commit":"a1345d246a856fed3bd64fd69e08c44f8b46bbf4"},"previous_names":[],"tags_count":43,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wp-cli%2Fpackage-command","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wp-cli%2Fpackage-command/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wp-cli%2Fpackage-command/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wp-cli%2Fpackage-command/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wp-cli","download_url":"https://codeload.github.com/wp-cli/package-command/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237877022,"owners_count":19380346,"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","composer","hacktoberfest","package","package-management","wordpress","wp-cli","wp-cli-package"],"created_at":"2025-01-15T08:52:12.378Z","updated_at":"2025-10-04T05:39:07.599Z","avatar_url":"https://github.com/wp-cli.png","language":"PHP","readme":"wp-cli/package-command\n======================\n\nLists, installs, and removes WP-CLI packages.\n\n[![Testing](https://github.com/wp-cli/package-command/actions/workflows/testing.yml/badge.svg)](https://github.com/wp-cli/package-command/actions/workflows/testing.yml)\n\nQuick links: [Using](#using) | [Installing](#installing) | [Contributing](#contributing) | [Support](#support)\n\n## Using\n\nThis package implements the following commands:\n\n### wp package\n\nLists, installs, and removes WP-CLI packages.\n\n~~~\nwp package\n~~~\n\nWP-CLI packages are community-maintained projects built on WP-CLI. They can\ncontain WP-CLI commands, but they can also just extend WP-CLI in some way.\n\nLearn how to create your own command from the\n[Commands Cookbook](https://make.wordpress.org/cli/handbook/guides/commands-cookbook/)\n\n**EXAMPLES**\n\n    # List installed packages.\n    $ wp package list\n    +-----------------------+------------------+----------+-----------+----------------+\n    | name                  | authors          | version  | update    | update_version |\n    +-----------------------+------------------+----------+-----------+----------------+\n    | wp-cli/server-command | Daniel Bachhuber | dev-main | available | 2.x-dev        |\n    +-----------------------+------------------+----------+-----------+----------------+\n\n    # Install the latest development version of the package.\n    $ wp package install wp-cli/server-command\n    Installing package wp-cli/server-command (dev-main)\n    Updating /home/person/.wp-cli/packages/composer.json to require the package...\n    Using Composer to install the package...\n    ---\n    Loading composer repositories with package information\n    Updating dependencies\n    Resolving dependencies through SAT\n    Dependency resolution completed in 0.005 seconds\n    Analyzed 732 packages to resolve dependencies\n    Analyzed 1034 rules to resolve dependencies\n     - Installing package\n    Writing lock file\n    Generating autoload files\n    ---\n    Success: Package installed.\n\n    # Uninstall package.\n    $ wp package uninstall wp-cli/server-command\n    Removing require statement for package 'wp-cli/server-command' from /home/person/.wp-cli/packages/composer.json\n    Removing repository details from /home/person/.wp-cli/packages/composer.json\n    Removing package directories and regenerating autoloader...\n    Success: Uninstalled package.\n\n\n\n### wp package browse\n\nBrowses WP-CLI packages available for installation.\n\n~~~\nwp package browse [--fields=\u003cfields\u003e] [--format=\u003cformat\u003e]\n~~~\n\nLists packages available for installation from the [Package Index](http://wp-cli.org/package-index/).\nAlthough the package index will remain in place for backward compatibility reasons, it has been\ndeprecated and will not be updated further. Please refer to https://github.com/wp-cli/ideas/issues/51\nto read about its potential replacement.\n\n**OPTIONS**\n\n\t[--fields=\u003cfields\u003e]\n\t\tLimit the output to specific fields. Defaults to all fields.\n\n\t[--format=\u003cformat\u003e]\n\t\tRender output in a particular format.\n\t\t---\n\t\tdefault: table\n\t\toptions:\n\t\t  - table\n\t\t  - csv\n\t\t  - ids\n\t\t  - json\n\t\t  - yaml\n\t\t---\n\n**AVAILABLE FIELDS**\n\nThese fields will be displayed by default for each package:\n\n* name\n* description\n* authors\n* version\n\nThere are no optionally available fields.\n\n**EXAMPLES**\n\n    $ wp package browse --format=yaml\n    ---\n    10up/mu-migration:\n      name: 10up/mu-migration\n      description: A set of WP-CLI commands to support the migration of single WordPress instances to multisite\n      authors: Nícholas André\n      version: dev-main, dev-develop\n    aaemnnosttv/wp-cli-dotenv-command:\n      name: aaemnnosttv/wp-cli-dotenv-command\n      description: Dotenv commands for WP-CLI\n      authors: Evan Mattson\n      version: v0.1, v0.1-beta.1, v0.2, dev-main, dev-dev, dev-develop, dev-tests/behat\n    aaemnnosttv/wp-cli-http-command:\n      name: aaemnnosttv/wp-cli-http-command\n      description: WP-CLI command for using the WordPress HTTP API\n      authors: Evan Mattson\n      version: dev-main\n\n\n\n### wp package install\n\nInstalls a WP-CLI package.\n\n~~~\nwp package install \u003cname|git|path|zip\u003e [--insecure]\n~~~\n\nPackages are required to be a valid Composer package, and can be\nspecified as:\n\n* Package name from WP-CLI's package index.\n* Git URL accessible by the current shell user.\n* Path to a directory on the local machine.\n* Local or remote .zip file.\n\nPackages are installed to `~/.wp-cli/packages/` by default. Use the\n`WP_CLI_PACKAGES_DIR` environment variable to provide a custom path.\n\nWhen installing a local directory, WP-CLI simply registers a\nreference to the directory. If you move or delete the directory, WP-CLI's\nreference breaks.\n\nWhen installing a .zip file, WP-CLI extracts the package to\n`~/.wp-cli/packages/local/\u003cpackage-name\u003e`.\n\nIf Github token authorization is required, a GitHub Personal Access Token\n(https://github.com/settings/tokens) can be used. The following command\nwill add a GitHub Personal Access Token to Composer's global configuration:\ncomposer config -g github-oauth.github.com \u003cGITHUB_TOKEN\u003e\nOnce this has been added, the value used for \u003cGITHUB_TOKEN\u003e will be used\nfor future authorization requests.\n\n**OPTIONS**\n\n\t\u003cname|git|path|zip\u003e\n\t\tName, git URL, directory path, or .zip file for the package to install.\n\t\tNames can optionally include a version constraint\n\t\t(e.g. wp-cli/server-command:@stable).\n\n\t[--insecure]\n\t\tRetry downloads without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack.\n\n**EXAMPLES**\n\n    # Install a package hosted at a git URL.\n    $ wp package install runcommand/hook\n\n    # Install the latest stable version.\n    $ wp package install wp-cli/server-command:@stable\n\n    # Install a package hosted at a GitLab.com URL.\n    $ wp package install https://gitlab.com/foo/wp-cli-bar-command.git\n\n    # Install a package in a .zip file.\n    $ wp package install google-sitemap-generator-cli.zip\n\n\n\n### wp package list\n\nLists installed WP-CLI packages.\n\n~~~\nwp package list [--fields=\u003cfields\u003e] [--format=\u003cformat\u003e]\n~~~\n\n**OPTIONS**\n\n\t[--fields=\u003cfields\u003e]\n\t\tLimit the output to specific fields. Defaults to all fields.\n\n\t[--format=\u003cformat\u003e]\n\t\tRender output in a particular format.\n\t\t---\n\t\tdefault: table\n\t\toptions:\n\t\t  - table\n\t\t  - csv\n\t\t  - ids\n\t\t  - json\n\t\t  - yaml\n\t\t---\n\n**AVAILABLE FIELDS**\n\nThese fields will be displayed by default for each package:\n\n* name\n* authors\n* version\n* update\n* update_version\n\nThese fields are optionally available:\n\n* description\n\n**EXAMPLES**\n\n    # List installed packages.\n    $ wp package list\n    +-----------------------+------------------+----------+-----------+----------------+\n    | name                  | authors          | version  | update    | update_version |\n    +-----------------------+------------------+----------+-----------+----------------+\n    | wp-cli/server-command | Daniel Bachhuber | dev-main | available | 2.x-dev        |\n    +-----------------------+------------------+----------+-----------+----------------+\n\n\n\n### wp package update\n\nUpdates all installed WP-CLI packages to their latest version.\n\n~~~\nwp package update \n~~~\n\n**EXAMPLES**\n\n    $ wp package update\n    Using Composer to update packages...\n    ---\n    Loading composer repositories with package information\n    Updating dependencies\n    Resolving dependencies through SAT\n    Dependency resolution completed in 0.074 seconds\n    Analyzed 1062 packages to resolve dependencies\n    Analyzed 22383 rules to resolve dependencies\n    Writing lock file\n    Generating autoload files\n    ---\n    Success: Packages updated.\n\n\n\n### wp package uninstall\n\nUninstalls a WP-CLI package.\n\n~~~\nwp package uninstall \u003cname\u003e [--insecure]\n~~~\n\n**OPTIONS**\n\n\t\u003cname\u003e\n\t\tName of the package to uninstall.\n\n\t[--insecure]\n\t\tRetry downloads without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack.\n\n**EXAMPLES**\n\n    # Uninstall package.\n    $ wp package uninstall wp-cli/server-command\n    Removing require statement for package 'wp-cli/server-command' from /home/person/.wp-cli/packages/composer.json\n    Removing repository details from /home/person/.wp-cli/packages/composer.json\n    Removing package directories and regenerating autoloader...\n    Success: Uninstalled package.\n\n## Installing\n\nThis package is included with WP-CLI itself, no additional installation necessary.\n\nTo install the latest version of this package over what's included in WP-CLI, run:\n\n    wp package install git@github.com:wp-cli/package-command.git\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/package-command/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/package-command/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/package-command/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*This README.md is generated dynamically from the project's codebase using `wp scaffold package-readme` ([doc](https://github.com/wp-cli/scaffold-package-command#wp-scaffold-package-readme)). To suggest changes, please submit a pull request against the corresponding part of the codebase.*\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwp-cli%2Fpackage-command","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwp-cli%2Fpackage-command","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwp-cli%2Fpackage-command/lists"}