Skip to content

Commit 40131f0

Browse files
danielbachhuberdanielbachhuber
committed
Regenerate command docs
1 parent fb7d9db commit 40131f0

87 files changed

Lines changed: 373 additions & 40 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Phakefile.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ function generate_synopsis( $command, $path = '' ) {
3434
}
3535
}
3636

37-
generate_synopsis( invoke_wp_cli( 'wp cli cmd-dump', $app ) );
37+
generate_synopsis( invoke_wp_cli( 'wp --skip-packages cli cmd-dump', $app ) );
3838
});
3939

4040
function gen_cmd_pages( $cmd, $parent = array() ) {
@@ -84,7 +84,7 @@ function gen_cmd_pages( $cmd, $parent = array() ) {
8484

8585
desc( 'Update the /commands/ page.' );
8686
task( 'cmd-list', function( $app ) {
87-
$wp = invoke_wp_cli( 'wp cli cmd-dump', $app );
87+
$wp = invoke_wp_cli( 'wp --skip-packages cli cmd-dump', $app );
8888

8989
// generate main page
9090
file_put_contents( '_includes/cmd-list.html', render( 'cmd-list.mustache', $wp ) );

‎_includes/cmd-list.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,10 @@
6262
<td><a href="/commands/option/">option</a></td>
6363
<td>Manage options.</td>
6464
</tr>
65+
<tr>
66+
<td><a href="/commands/package/">package</a></td>
67+
<td>Manage WP-CLI packages.</td>
68+
</tr>
6569
<tr>
6670
<td><a href="/commands/plugin/">plugin</a></td>
6771
<td>Manage plugins.</td>

‎_includes/global-parameters.html‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,11 @@ <h3>Global Parameters</h3>
99
<p><code>--user=&lt;id|login|email&gt;</code>
1010
Set the WordPress user.</p>
1111
<p><code>--skip-plugins[=&lt;plugin&gt;]</code>
12-
Skip loading all or some plugins.</p>
12+
Skip loading all or some plugins. Note: mu-plugins are still loaded.</p>
1313
<p><code>--skip-themes[=&lt;theme&gt;]</code>
1414
Skip loading all or some themes.</p>
15+
<p><code>--skip-packages</code>
16+
Skip loading all installed packages.</p>
1517
<p><code>--require=&lt;path&gt;</code>
1618
Load PHP file before running the command (may be used more than once).</p>
1719
<p><code>--[no-]color</code>

‎_includes/param-list.html‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
</tr>
4040
<tr>
4141
<td>
42-
Skip loading all or some plugins.
42+
Skip loading all or some plugins. Note: mu-plugins are still loaded.
4343
<br />
4444
Default value: <code>&quot;&quot;</code>
4545
</td>
@@ -63,6 +63,19 @@
6363
<code class="flag">--skip-themes[=&lt;theme&gt;]</code>
6464
</td>
6565
</tr>
66+
<tr>
67+
<td>
68+
Skip loading all installed packages.
69+
<br />
70+
Default value: <code>false</code>
71+
</td>
72+
<td>
73+
<code class="option">skip-packages: &lt;bool&gt;</code>
74+
</td>
75+
<td>
76+
<code class="flag">--skip-packages</code>
77+
</td>
78+
</tr>
6679
<tr>
6780
<td>
6881
Load PHP file before running the command (may be used more than once).

‎commands/cache/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ display_global_parameters: true
1414

1515
wp cache get my_key my_group
1616

17+
18+
1719
### SUBCOMMANDS
1820

1921
<table>

‎commands/cap/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ display_global_parameters: true
1919
# Remove all caps from 'editor' role that also appear in 'author' role
2020
wp cap list 'author' | xargs wp cap remove 'editor'
2121

22+
23+
2224
### SUBCOMMANDS
2325

2426
<table>

‎commands/cli/api-dump/index.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
layout: default
3+
title: 'wp cli api-dump'
4+
display_global_parameters: true
5+
---
6+
7+
`wp cli api-dump` - Dump the list of internal APIs, as JSON.
8+
9+
<hr />
10+
11+
Used to build user-facing docs of public APIs.
12+
13+
14+

‎commands/cli/index.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ display_global_parameters: true
1010

1111

1212

13+
14+
1315
### SUBCOMMANDS
1416

1517
<table>
@@ -20,6 +22,10 @@ display_global_parameters: true
2022
</tr>
2123
</thead>
2224
<tbody>
25+
<tr>
26+
<td><a href="/commands/cli/api-dump/">api-dump</a></td>
27+
<td>Dump the list of internal APIs, as JSON.</td>
28+
</tr>
2329
<tr>
2430
<td><a href="/commands/cli/check-update/">check-update</a></td>
2531
<td>Check for update via Github API. Returns the available versions if there are updates, or empty if no update available.</td>

‎commands/comment/generate/index.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,8 @@ display_global_parameters: true
1313
[\--count=&lt;number&gt;]
1414
: How many comments to generate. Default: 100
1515

16+
[\--post_id=&lt;post-id&gt;]
17+
: Assign comments to a specific post.
18+
1619

1720

‎commands/comment/get/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ display_global_parameters: true
2020
: Limit the output to specific fields. Defaults to all fields.
2121

2222
[\--format=&lt;format&gt;]
23-
: Accepted values: table, json, csv. Default: table
23+
: Accepted values: table, json, csv, yaml. Default: table
2424

2525
### EXAMPLES
2626

0 commit comments

Comments
 (0)