Skip to content

Update docs and examples for package commands #186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
swissspidy merged 2 commits into from
Apr 26, 2024
Merged

Update docs and examples for package commands #186

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d2f5aec
Update docs and examples in package commands
ernilambar Apr 5, 2024
8b57210
Update readme file to reflect updated docs
ernilambar Apr 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update readme file to reflect updated docs
  • Loading branch information
@ernilambar
ernilambar committed Apr 5, 2024
commit 8b57210ef204d7e765c2958e00802ad055bc3863
42 changes: 22 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,19 @@ WP-CLI packages are community-maintained projects built on WP-CLI. They can
contain WP-CLI commands, but they can also just extend WP-CLI in some way.

Learn how to create your own command from the
[Commands Cookbook](https://make.wordpress.org/cli/handbook/commands-cookbook/)
[Commands Cookbook](https://make.wordpress.org/cli/handbook/guides/commands-cookbook/)

**EXAMPLES**

# List installed packages
# List installed packages.
$ wp package list
+-----------------------+------------------------------------------+---------+----------+
| name | description | authors | version |
+-----------------------+------------------------------------------+---------+----------+
| wp-cli/server-command | Start a development server for WordPress | | dev-main |
+-----------------------+------------------------------------------+---------+----------+
+-----------------------+------------------+----------+-----------+----------------+
| name | authors | version | update | update_version |
+-----------------------+------------------+----------+-----------+----------------+
| wp-cli/server-command | Daniel Bachhuber | dev-main | available | 2.x-dev |
+-----------------------+------------------+----------+-----------+----------------+

# Install the latest development version of the package
# Install the latest development version of the package.
$ wp package install wp-cli/server-command
Installing package wp-cli/server-command (dev-main)
Updating /home/person/.wp-cli/packages/composer.json to require the package...
Expand All @@ -53,11 +53,11 @@ Learn how to create your own command from the
---
Success: Package installed.

# Uninstall package
# Uninstall package.
$ wp package uninstall wp-cli/server-command
Removing require statement from /home/person/.wp-cli/packages/composer.json
Deleting package directory /home/person/.wp-cli/packages/vendor/wp-cli/server-command
Regenerating Composer autoload.
Removing require statement for package 'wp-cli/server-command' from /home/person/.wp-cli/packages/composer.json
Removing repository details from /home/person/.wp-cli/packages/composer.json
Removing package directories and regenerating autoloader...
Success: Uninstalled package.


Expand Down Expand Up @@ -225,12 +225,13 @@ These fields are optionally available:

**EXAMPLES**

# List installed packages.
$ wp package list
+-----------------------+------------------------------------------+---------+----------+
| name | description | authors | version |
+-----------------------+------------------------------------------+---------+----------+
| wp-cli/server-command | Start a development server for WordPress | | dev-main |
+-----------------------+------------------------------------------+---------+----------+
+-----------------------+------------------+----------+-----------+----------------+
| name | authors | version | update | update_version |
+-----------------------+------------------+----------+-----------+----------------+
| wp-cli/server-command | Daniel Bachhuber | dev-main | available | 2.x-dev |
+-----------------------+------------------+----------+-----------+----------------+



Expand Down Expand Up @@ -278,10 +279,11 @@ wp package uninstall <name> [--insecure]

**EXAMPLES**

# Uninstall package.
$ wp package uninstall wp-cli/server-command
Removing require statement from /home/person/.wp-cli/packages/composer.json
Deleting package directory /home/person/.wp-cli/packages/vendor/wp-cli/server-command
Regenerating Composer autoload.
Removing require statement for package 'wp-cli/server-command' from /home/person/.wp-cli/packages/composer.json
Removing repository details from /home/person/.wp-cli/packages/composer.json
Removing package directories and regenerating autoloader...
Success: Uninstalled package.

## Installing
Expand Down