update command docs for WP 0.13

scribu · scribu · commit 7fcf14c0e47d · 2013-11-30T15:03:19.000+02:00
diff --git a/_includes/cmd-list.html b/_includes/cmd-list.html
@@ -14,6 +14,10 @@
 		<td><a href="/commands/comment/">comment</a></td>
 		<td>Manage comments.</td>
 	</tr>
+	<tr>
+		<td><a href="/commands/comment-meta/">comment-meta</a></td>
+		<td>Manage comment custom fields.</td>
+	</tr>
 	<tr>
 		<td><a href="/commands/core/">core</a></td>
 		<td>Download, install, update and otherwise manage WordPress proper.</td>
diff --git a/_includes/param-list.html b/_includes/param-list.html
@@ -1,9 +1,3 @@
-	<tr>
-		<td><code></code></td>
-		<td><code>--config=&lt;path&gt;</code></td>
-		<td><code>null</code></td>
-		<td>Path to the wp-cli config file</td>
-	</tr>
 	<tr>
 		<td><code>path: &lt;path&gt;</code></td>
 		<td><code>--path=&lt;path&gt;</code></td>
diff --git a/commands/cap/list/index.md b/commands/cap/list/index.md
@@ -5,5 +5,8 @@ title: 'wp cap list'
 
 `wp cap list` - List capabilities for a given role.
 
+### EXAMPLES
 
+    # Display alphabetical list of bbPress moderator capabilities
+    wp cap list 'bbp_moderator' | sort
 
diff --git a/commands/cli/info/index.md b/commands/cli/info/index.md
@@ -5,5 +5,8 @@ title: 'wp cli info'
 
 `wp cli info` - Print various data about the CLI environment.
 
+### OPTIONS
 
+[\--format=&lt;format&gt;]
+: Accepted values: json
 
diff --git a/commands/comment-meta/add/index.md b/commands/comment-meta/add/index.md
@@ -0,0 +1,9 @@
+---
+layout: default
+title: 'wp comment-meta add'
+---
+
+`wp comment-meta add` - Add a meta field.
+
+
+
diff --git a/commands/comment-meta/delete/index.md b/commands/comment-meta/delete/index.md
@@ -0,0 +1,9 @@
+---
+layout: default
+title: 'wp comment-meta delete'
+---
+
+`wp comment-meta delete` - Delete a meta field.
+
+
+
diff --git a/commands/comment-meta/get/index.md b/commands/comment-meta/get/index.md
@@ -0,0 +1,9 @@
+---
+layout: default
+title: 'wp comment-meta get'
+---
+
+`wp comment-meta get` - Get meta field value.
+
+
+
diff --git a/commands/comment-meta/index.md b/commands/comment-meta/index.md
@@ -0,0 +1,44 @@
+---
+layout: default
+title: 'wp comment-meta'
+---
+
+`wp comment-meta` - Manage comment custom fields.
+
+### OPTIONS
+
+\--format=json
+: Encode/decode values as JSON.
+
+### EXAMPLES
+
+    wp comment-meta set 123 description &quot;Mary is a WordPress developer.&quot;
+
+### SUBCOMMANDS
+
+<table>
+	<thead>
+	<tr>
+		<th>Name</th>
+		<th>Description</th>
+	</tr>
+	</thead>
+	<tbody>
+		<tr>
+			<td><a href="/commands/comment-meta/add/">add</a></td>
+			<td>Add a meta field.</td>
+		</tr>
+		<tr>
+			<td><a href="/commands/comment-meta/delete/">delete</a></td>
+			<td>Delete a meta field.</td>
+		</tr>
+		<tr>
+			<td><a href="/commands/comment-meta/get/">get</a></td>
+			<td>Get meta field value.</td>
+		</tr>
+		<tr>
+			<td><a href="/commands/comment-meta/update/">update</a></td>
+			<td>Update a meta field.</td>
+		</tr>
+	</tbody>
+</table>
diff --git a/commands/comment-meta/update/index.md b/commands/comment-meta/update/index.md
@@ -0,0 +1,9 @@
+---
+layout: default
+title: 'wp comment-meta update'
+---
+
+`wp comment-meta update` - Update a meta field.
+
+
+
diff --git a/commands/comment/get/index.md b/commands/comment/get/index.md
@@ -14,10 +14,7 @@ title: 'wp comment get'
 : Instead of returning the whole comment, returns the value of a single field.
 
 [\--format=&lt;format&gt;]
-: The format to use when printing the comment, acceptable values:
-
-  - **table**: Outputs all fields of the comment as a table.
-  - **json**: Outputs all fields in JSON format.
+: Accepted values: table, json. Default: table
 
 ### EXAMPLES
 
diff --git a/commands/comment/list/index.md b/commands/comment/list/index.md
@@ -17,7 +17,7 @@ title: 'wp comment list'
 : Limit the output to specific object fields. Defaults to comment_ID,comment_post_ID,comment_date,comment_approved,comment_author,comment_author_email
 
 [\--format=&lt;format&gt;]
-: Output list as table, CSV, JSON, or simply IDs. Defaults to table.
+: Accepted values: table, csv, json, count. Default: table
 
 ### EXAMPLES
 
diff --git a/commands/core/download/index.md b/commands/core/download/index.md
@@ -7,6 +7,9 @@ title: 'wp core download'
 
 ### OPTIONS
 
+[\--path=&lt;path&gt;]
+: Specify the path in which to install WordPress.
+
 [\--locale=&lt;locale&gt;]
 : Select which language you want to download.
 
diff --git a/commands/core/index.md b/commands/core/index.md
@@ -25,10 +25,6 @@ title: 'wp core'
 			<td><a href="/commands/core/download/">download</a></td>
 			<td>Download core WordPress files.</td>
 		</tr>
-		<tr>
-			<td><a href="/commands/core/init-tests/">init-tests</a></td>
-			<td>Set up the official test suite using the current WordPress instance.</td>
-		</tr>
 		<tr>
 			<td><a href="/commands/core/install/">install</a></td>
 			<td>Create the WordPress tables in the database.</td>
diff --git a/commands/core/init-tests/index.md b/commands/core/init-tests/index.md
diff --git a/commands/export/index.md b/commands/export/index.md
@@ -37,7 +37,7 @@ to current working directory.
 [\--author=&lt;login/id&gt;]
 : Export only posts by this author.
 
-[\--category=&lt;category-id&gt;]
+[\--category=&lt;name&gt;]
 : Export only posts in this category.
 
 [\--post_status=&lt;status&gt;]
diff --git a/commands/import/index.md b/commands/import/index.md
@@ -14,5 +14,5 @@ title: 'wp import'
 : How the author mapping should be handled. Options are 'create', 'mapping.csv', or 'skip'. The first will create any non-existent users from the WXR file. The second will read author mapping associations from a CSV, or create a CSV for editing if the file path doesn't exist. The last option will skip any author mapping.
 
 [\--skip=&lt;data-type&gt;]
-: Skip importing specific data. Supported option is 'attachment'.
+: Skip importing specific data. Supported options are: 'attachment' and 'image_resize' (skip time-consuming thumbnail generation).
 
diff --git a/commands/plugin/deactivate/index.md b/commands/plugin/deactivate/index.md
@@ -7,9 +7,12 @@ title: 'wp plugin deactivate'
 
 ### OPTIONS
 
-&lt;plugin&gt;...
+[&lt;plugin&gt;...]
 : One or more plugins to deactivate.
 
+[\--all]
+: If set, all plugins will be deactivated.
+
 [\--network]
 : If set, the plugin will be deactivated for the entire multisite network.
 
diff --git a/commands/plugin/list/index.md b/commands/plugin/list/index.md
@@ -7,16 +7,19 @@ title: 'wp plugin list'
 
 ### OPTIONS
 
+[\--&lt;field&gt;=&lt;value&gt;]
+: Filter results based on the value of a field.
+
 [\--field=&lt;field&gt;]
 : Prints the value of a single field for each plugin.
 
 [\--fields=&lt;fields&gt;]
 : Limit the output to specific object fields. Defaults to name,status,update,version.
 
 [\--format=&lt;format&gt;]
-: Output list as table, CSV or JSON. Defaults to table.
+: Accepted values: table, csv, json, count. Default: table
 
 ### EXAMPLES
 
-    wp plugin list --format=json
+    wp plugin list --status=active --format=json
 
diff --git a/commands/plugin/search/index.md b/commands/plugin/search/index.md
@@ -13,8 +13,8 @@ title: 'wp plugin search'
 [\--per-page=&lt;per-page&gt;]
 : Optional number of results to display. Defaults to 10.
 
-[\--format=&lt;format&gt;]
-: Output list as table, CSV or JSON. Defaults to table.
+[\--field=&lt;field&gt;]
+: Prints the value of a single field for each plugin.
 
 [\--fields=&lt;fields&gt;]
 : Ask for specific fields from the API. Defaults to name,slug,author_profile,rating. Acceptable values:
@@ -34,6 +34,9 @@ title: 'wp plugin search'
     **description**: Plugin's Description
     **short_description**: Plugin's Short Description
 
+[\--format=&lt;format&gt;]
+: Accepted values: table, csv, json, count. Default: table
+
 ### EXAMPLES
 
     wp plugin search dsgnwrks --per-page=20 --format=json
diff --git a/commands/post/generate/index.md b/commands/post/generate/index.md
@@ -22,10 +22,14 @@ title: 'wp post generate'
 [\--post_date=&lt;yyyy-mm-dd&gt;]
 : The date of the generated posts. Default: current date
 
+[\--post_content]
+: If set, the command reads the post_content from STDIN.
+
 [\--max_depth=&lt;number&gt;]
 : For hierarchical post types, generate child posts down to a certain depth. Default: 1
 
 ### EXAMPLES
 
     wp post generate --count=10 --post_type=page --post_date=1999-01-04
+    curl http://loripsum.net/api/5 | wp post generate --post_content --count=10
 
diff --git a/commands/post/get/index.md b/commands/post/get/index.md
@@ -14,12 +14,7 @@ title: 'wp post get'
 : Instead of returning the whole post, returns the value of a single field.
 
 [\--format=&lt;format&gt;]
-: The format to use when printing the post, acceptable values:
-
-  - **table**: Outputs all fields of the post as a table. Note that the
-    post_content field is omitted so that the table is readable.
-
-  - **json**: Outputs all fields in JSON format.
+: Accepted values: table, json. Default: table
 
 ### EXAMPLES
 
diff --git a/commands/post/list/index.md b/commands/post/list/index.md
@@ -17,7 +17,7 @@ title: 'wp post list'
 : Limit the output to specific object fields. Defaults to ID,post_title,post_name,post_date,post_status.
 
 [\--format=&lt;format&gt;]
-: Output list as table, CSV, JSON, or simply IDs. Defaults to table.
+: Accepted values: table, csv, json, count. Default: table
 
 ### EXAMPLES
 
diff --git a/commands/rewrite/list/index.md b/commands/rewrite/list/index.md
@@ -7,8 +7,14 @@ title: 'wp rewrite list'
 
 ### OPTIONS
 
+[\--match=&lt;url&gt;]
+: Show rewrite rules matching a particular URL.
+
+[\--source=&lt;source&gt;]
+: Show rewrite rules from a particular source.
+
 [\--format=&lt;format&gt;]
-: Output list as table, JSON or CSV. Defaults to table.
+: Accepted values: table, csv, json, count. Default: table
 
 ### EXAMPLES
 
diff --git a/commands/role/list/index.md b/commands/role/list/index.md
@@ -11,7 +11,7 @@ title: 'wp role list'
 : Limit the output to specific object fields. Defaults to name,role.
 
 [\--format=&lt;format&gt;]
-: Output list as table, CSV or JSON. Defaults to table.
+: Accepted values: table, csv, json, count. Default: table
 
 ### EXAMPLES
 
diff --git a/commands/scaffold/plugin/index.md b/commands/scaffold/plugin/index.md
@@ -10,9 +10,12 @@ title: 'wp scaffold plugin'
 &lt;slug&gt;
 : The internal name of the plugin.
 
-[\--activate]
-: Activate the newly generated plugin.
-
 [\--plugin_name=&lt;title&gt;]
 : What to put in the 'Plugin Name:' header
 
+[\--skip-tests]
+: Don't generate files for unit testing.
+
+[\--activate]
+: Activate the newly generated plugin.
+
diff --git a/commands/site/list/index.md b/commands/site/list/index.md
@@ -17,7 +17,7 @@ title: 'wp site list'
 : Comma-separated list of fields to show.
 
 [\--format=&lt;format&gt;]
-: Output list as table, csv, json or url. Defaults to table.
+: Accepted values: table, csv, json, count. Default: table
 
 ### EXAMPLES
 
diff --git a/commands/term/get/index.md b/commands/term/get/index.md
@@ -17,10 +17,7 @@ title: 'wp term get'
 : Instead of returning the whole term, returns the value of a single field.
 
 [\--format=&lt;format&gt;]
-: The format to use when printing the term, acceptable values:
-
-  - **table**: Outputs all fields of the term as a table.
-  - **json**: Outputs all fields in JSON format.
+: Accepted values: table, json. Default: table
 
 ### EXAMPLES
 
diff --git a/commands/term/list/index.md b/commands/term/list/index.md
@@ -20,7 +20,7 @@ title: 'wp term list'
 : Limit the output to specific object fields. Defaults to all of the term object fields.
 
 [\--format=&lt;format&gt;]
-: Output list as table, CSV, JSON, or simply IDs. Defaults to table.
+: Accepted values: table, csv, json, count. Default: table
 
 ### EXAMPLES
 
diff --git a/commands/theme/get/index.md b/commands/theme/get/index.md
@@ -14,7 +14,7 @@ title: 'wp theme get'
 : Instead of returning the whole theme, returns the value of a single field.
 
 [\--format=&lt;format&gt;]
-: Output list as table or JSON. Defaults to table.
+: Accepted values: table, json. Default: table
 
 ### EXAMPLES
 
diff --git a/commands/theme/list/index.md b/commands/theme/list/index.md
@@ -7,16 +7,19 @@ title: 'wp theme list'
 
 ### OPTIONS
 
+[\--&lt;field&gt;=&lt;value&gt;]
+: Filter results based on the value of a field.
+
 [\--field=&lt;field&gt;]
 : Prints the value of a single field for each theme.
 
 [\--fields=&lt;fields&gt;]
 : Limit the output to specific object fields. Defaults to name,status,update,version.
 
 [\--format=&lt;format&gt;]
-: Output list as table, CSV or JSON. Defaults to table.
+: Accepted values: table, json. Default: table
 
 ### EXAMPLES
 
-    wp theme list --format=csv
+    wp theme list --status=inactive --format=csv
 
diff --git a/commands/theme/search/index.md b/commands/theme/search/index.md
diff --git a/commands/user/get/index.md b/commands/user/get/index.md
diff --git a/commands/user/list/index.md b/commands/user/list/index.md
