Skip to content

Commit d30f69a

Browse files
schlesseraschlessera
committed
Update handbook to release v2.2.0
1 parent 27a6bfd commit d30f69a

Some content is hidden

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

42 files changed

+623
-120
lines changed

‎bin/commands-manifest.json

+56-8
Original file line numberDiff line numberDiff line change
@@ -1519,14 +1519,6 @@
15191519
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/role\/reset.md",
15201520
"repo_url": "https:\/\/github.com\/wp-cli\/role-command"
15211521
},
1522-
"scaffold\/_s": {
1523-
"title": "scaffold _s",
1524-
"slug": "_s",
1525-
"cmd_path": "scaffold\/_s",
1526-
"parent": "scaffold",
1527-
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/scaffold\/_s.md",
1528-
"repo_url": "https:\/\/github.com\/wp-cli\/scaffold-command"
1529-
},
15301522
"scaffold\/block": {
15311523
"title": "scaffold block",
15321524
"slug": "block",
@@ -1583,6 +1575,14 @@
15831575
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/scaffold\/theme-tests.md",
15841576
"repo_url": "https:\/\/github.com\/wp-cli\/scaffold-command"
15851577
},
1578+
"scaffold\/underscores": {
1579+
"title": "scaffold underscores",
1580+
"slug": "underscores",
1581+
"cmd_path": "scaffold\/underscores",
1582+
"parent": "scaffold",
1583+
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/scaffold\/underscores.md",
1584+
"repo_url": "https:\/\/github.com\/wp-cli\/scaffold-command"
1585+
},
15861586
"sidebar\/list": {
15871587
"title": "sidebar list",
15881588
"slug": "list",
@@ -1815,6 +1815,14 @@
18151815
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/term\/meta.md",
18161816
"repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
18171817
},
1818+
"term\/migrate": {
1819+
"title": "term migrate",
1820+
"slug": "migrate",
1821+
"cmd_path": "term\/migrate",
1822+
"parent": "term",
1823+
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/term\/migrate.md",
1824+
"repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
1825+
},
18181826
"term\/recount": {
18191827
"title": "term recount",
18201828
"slug": "recount",
@@ -2199,6 +2207,46 @@
21992207
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/widget\/update.md",
22002208
"repo_url": "https:\/\/github.com\/wp-cli\/widget-command"
22012209
},
2210+
"cli\/alias\/add": {
2211+
"title": "cli alias add",
2212+
"slug": "add",
2213+
"cmd_path": "cli\/alias\/add",
2214+
"parent": "cli\/alias",
2215+
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/cli\/alias\/add.md",
2216+
"repo_url": "https:\/\/github.com\/wp-cli\/wp-cli"
2217+
},
2218+
"cli\/alias\/delete": {
2219+
"title": "cli alias delete",
2220+
"slug": "delete",
2221+
"cmd_path": "cli\/alias\/delete",
2222+
"parent": "cli\/alias",
2223+
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/cli\/alias\/delete.md",
2224+
"repo_url": "https:\/\/github.com\/wp-cli\/wp-cli"
2225+
},
2226+
"cli\/alias\/get": {
2227+
"title": "cli alias get",
2228+
"slug": "get",
2229+
"cmd_path": "cli\/alias\/get",
2230+
"parent": "cli\/alias",
2231+
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/cli\/alias\/get.md",
2232+
"repo_url": "https:\/\/github.com\/wp-cli\/wp-cli"
2233+
},
2234+
"cli\/alias\/list": {
2235+
"title": "cli alias list",
2236+
"slug": "list",
2237+
"cmd_path": "cli\/alias\/list",
2238+
"parent": "cli\/alias",
2239+
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/cli\/alias\/list.md",
2240+
"repo_url": "https:\/\/github.com\/wp-cli\/wp-cli"
2241+
},
2242+
"cli\/alias\/update": {
2243+
"title": "cli alias update",
2244+
"slug": "update",
2245+
"cmd_path": "cli\/alias\/update",
2246+
"parent": "cli\/alias",
2247+
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/cli\/alias\/update.md",
2248+
"repo_url": "https:\/\/github.com\/wp-cli\/wp-cli"
2249+
},
22022250
"cli\/cache\/clear": {
22032251
"title": "cli cache clear",
22042252
"slug": "clear",

‎bin/handbook-manifest.json

+6
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,12 @@
245245
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/internal-api\/wp-cli-halt.md",
246246
"parent": "internal-api"
247247
},
248+
"wp-cli-has-config": {
249+
"title": "WP_CLI::has_config()",
250+
"slug": "wp-cli-has-config",
251+
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/internal-api\/wp-cli-has-config.md",
252+
"parent": "internal-api"
253+
},
248254
"wp-cli-launch-self": {
249255
"title": "WP_CLI::launch_self()",
250256
"slug": "wp-cli-launch-self",

‎commands/cli/alias.md

+28-44
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,36 @@
11
# wp cli alias
22

3-
List available WP-CLI aliases.
3+
Retrieves, sets and updates aliases for WordPress Installations.
44

5-
Aliases are shorthand references to WordPress installations. For instance, `@dev` could refer to a development installation and `@prod` could refer to a production installation. This command gives you visibility in what registered aliases you have available.
6-
7-
### OPTIONS
8-
9-
[\--format=<format>]
10-
: Render output in a particular format.
11-
\---
12-
default: yaml
13-
options:
14-
- yaml
15-
- json
16-
- var_export
17-
\---
5+
Aliases are shorthand references to WordPress installs. For instance, `@dev` could refer to a development install and `@prod` could refer to a production install. This command gives you and option to add, update and delete, the registered aliases you have available.
186

197
### EXAMPLES
208

21-
# List all available aliases.
22-
$ wp cli alias
9+
# List alias information.
10+
$ wp cli alias list
11+
list
2312
---
24-
2513
@all: Run command against every registered alias.
26-
@prod:
27-
ssh: runcommand@runcommand.io~/webapps/production
28-
@dev:
29-
ssh: vagrant@192.168.50.10/srv/www/runcommand.dev
30-
@both:
31-
- @prod
32-
- @dev
33-
34-
### GLOBAL PARAMETERS
35-
36-
These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress.
37-
38-
| **Argument** | **Description** |
39-
|:----------------|:-----------------------------|
40-
| `--path=<path>` | Path to the WordPress files. |
41-
| `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
42-
| `--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). |
43-
| `--http=<http>` | Perform operation against a remote WordPress installation over HTTP. |
44-
| `--user=<id\|login\|email>` | Set the WordPress user. |
45-
| `--skip-plugins[=<plugins>]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. |
46-
| `--skip-themes[=<themes>]` | Skip loading all themes, or a comma-separated list of themes. |
47-
| `--skip-packages` | Skip loading all installed packages. |
48-
| `--require=<path>` | Load PHP file before running the command (may be used more than once). |
49-
| `--[no-]color` | Whether to colorize the output. |
50-
| `--debug[=<group>]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. |
51-
| `--prompt[=<assoc>]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. |
52-
| `--quiet` | Suppress informational messages. |
14+
@local:
15+
user: wpcli
16+
path: /Users/wpcli/sites/testsite
17+
18+
# Get alias information.
19+
$ wp cli alias get @dev
20+
ssh: dev@somedeve.env:12345/home/dev/
21+
22+
# Add alias.
23+
$ wp cli alias add prod --set-ssh=login@host --set-path=/path/to/wordpress/install/ --set-user=wpcli
24+
Success: Added '@prod' alias.
25+
26+
# Update alias.
27+
$ wp cli alias update @prod --set-user=newuser --set-path=/new/path/to/wordpress/install/
28+
Success: Updated 'prod' alias.
29+
30+
# Delete alias.
31+
$ wp cli alias delete @prod
32+
Success: Deleted '@prod' alias.
33+
34+
35+
36+

‎commands/cli/alias/add.md

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# wp cli alias add
2+
3+
Creates an alias.
4+
5+
### OPTIONS
6+
7+
&lt;key&gt;
8+
: Key for the alias.
9+
10+
[\--set-user=&lt;user&gt;]
11+
: Set user for alias.
12+
13+
[\--set-url=&lt;url&gt;]
14+
: Set url for alias.
15+
16+
[\--set-path=&lt;path&gt;]
17+
: Set path for alias.
18+
19+
[\--set-ssh=&lt;ssh&gt;]
20+
: Set ssh for alias.
21+
22+
[\--set-http=&lt;http&gt;]
23+
: Set http for alias.
24+
25+
[\--grouping=&lt;grouping&gt;]
26+
: For grouping multiple aliases.
27+
28+
[\--config=&lt;config&gt;]
29+
: Config file to be considered for operations.
30+
\---
31+
default: global
32+
options:
33+
- global
34+
- project
35+
\---
36+
37+
### EXAMPLES
38+
39+
# Add alias to global config.
40+
$ wp cli alias add @prod --set-ssh=login@host --set-path=/path/to/wordpress/install/ --set-user=wpcli
41+
Success: Added '@prod' alias.
42+
43+
# Add alias to project config.
44+
$ wp cli alias add @prod --set-ssh=login@host --set-path=/path/to/wordpress/install/ --set-user=wpcli --config=project
45+
Success: Added '@prod' alias.
46+
47+
# Add group of aliases.
48+
$ wp cli alias add @multiservers --grouping=servera,serverb
49+
Success: Added '@multiservers' alias.
50+
51+
### GLOBAL PARAMETERS
52+
53+
These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress.
54+
55+
| **Argument** | **Description** |
56+
|:----------------|:-----------------------------|
57+
| `--path=<path>` | Path to the WordPress files. |
58+
| `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
59+
| `--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). |
60+
| `--http=<http>` | Perform operation against a remote WordPress installation over HTTP. |
61+
| `--user=<id\|login\|email>` | Set the WordPress user. |
62+
| `--skip-plugins[=<plugins>]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. |
63+
| `--skip-themes[=<themes>]` | Skip loading all themes, or a comma-separated list of themes. |
64+
| `--skip-packages` | Skip loading all installed packages. |
65+
| `--require=<path>` | Load PHP file before running the command (may be used more than once). |
66+
| `--[no-]color` | Whether to colorize the output. |
67+
| `--debug[=<group>]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. |
68+
| `--prompt[=<assoc>]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. |
69+
| `--quiet` | Suppress informational messages. |

‎commands/cli/alias/delete.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# wp cli alias delete
2+
3+
Deletes an alias.
4+
5+
### OPTIONS
6+
7+
&lt;key&gt;
8+
: Key for the alias.
9+
10+
[\--config=&lt;config&gt;]
11+
: Config file to be considered for operations.
12+
\---
13+
options:
14+
- global
15+
- project
16+
\---
17+
18+
### EXAMPLES
19+
20+
# Delete alias.
21+
$ wp cli alias delete @prod
22+
Success: Deleted '@prod' alias.
23+
24+
# Delete project alias.
25+
$ wp cli alias delete @prod --config=project
26+
Success: Deleted '@prod' alias.
27+
28+
### GLOBAL PARAMETERS
29+
30+
These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress.
31+
32+
| **Argument** | **Description** |
33+
|:----------------|:-----------------------------|
34+
| `--path=<path>` | Path to the WordPress files. |
35+
| `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
36+
| `--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). |
37+
| `--http=<http>` | Perform operation against a remote WordPress installation over HTTP. |
38+
| `--user=<id\|login\|email>` | Set the WordPress user. |
39+
| `--skip-plugins[=<plugins>]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. |
40+
| `--skip-themes[=<themes>]` | Skip loading all themes, or a comma-separated list of themes. |
41+
| `--skip-packages` | Skip loading all installed packages. |
42+
| `--require=<path>` | Load PHP file before running the command (may be used more than once). |
43+
| `--[no-]color` | Whether to colorize the output. |
44+
| `--debug[=<group>]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. |
45+
| `--prompt[=<assoc>]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. |
46+
| `--quiet` | Suppress informational messages. |

‎commands/cli/alias/get.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# wp cli alias get
2+
3+
Gets the value for an alias.
4+
5+
### OPTIONS
6+
7+
&lt;key&gt;
8+
: Key for the alias.
9+
10+
### EXAMPLES
11+
12+
# Get alias.
13+
$ wp cli alias get @prod
14+
ssh: dev@somedeve.env:12345/home/dev/
15+
16+
### GLOBAL PARAMETERS
17+
18+
These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress.
19+
20+
| **Argument** | **Description** |
21+
|:----------------|:-----------------------------|
22+
| `--path=<path>` | Path to the WordPress files. |
23+
| `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
24+
| `--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). |
25+
| `--http=<http>` | Perform operation against a remote WordPress installation over HTTP. |
26+
| `--user=<id\|login\|email>` | Set the WordPress user. |
27+
| `--skip-plugins[=<plugins>]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. |
28+
| `--skip-themes[=<themes>]` | Skip loading all themes, or a comma-separated list of themes. |
29+
| `--skip-packages` | Skip loading all installed packages. |
30+
| `--require=<path>` | Load PHP file before running the command (may be used more than once). |
31+
| `--[no-]color` | Whether to colorize the output. |
32+
| `--debug[=<group>]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. |
33+
| `--prompt[=<assoc>]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. |
34+
| `--quiet` | Suppress informational messages. |

‎commands/cli/alias/list.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# wp cli alias list
2+
3+
List available WP-CLI aliases.
4+
5+
### OPTIONS
6+
7+
[\--format=&lt;format&gt;]
8+
: Render output in a particular format.
9+
\---
10+
default: yaml
11+
options:
12+
- yaml
13+
- json
14+
- var_export
15+
\---
16+
17+
### EXAMPLES
18+
19+
# List all available aliases.
20+
$ wp cli alias list
21+
---
22+
@all: Run command against every registered alias.
23+
@prod:
24+
ssh: runcommand@runcommand.io~/webapps/production
25+
@dev:
26+
ssh: vagrant@192.168.50.10/srv/www/runcommand.dev
27+
@both:
28+
- @prod
29+
- @dev
30+
31+
### GLOBAL PARAMETERS
32+
33+
These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress.
34+
35+
| **Argument** | **Description** |
36+
|:----------------|:-----------------------------|
37+
| `--path=<path>` | Path to the WordPress files. |
38+
| `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
39+
| `--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). |
40+
| `--http=<http>` | Perform operation against a remote WordPress installation over HTTP. |
41+
| `--user=<id\|login\|email>` | Set the WordPress user. |
42+
| `--skip-plugins[=<plugins>]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. |
43+
| `--skip-themes[=<themes>]` | Skip loading all themes, or a comma-separated list of themes. |
44+
| `--skip-packages` | Skip loading all installed packages. |
45+
| `--require=<path>` | Load PHP file before running the command (may be used more than once). |
46+
| `--[no-]color` | Whether to colorize the output. |
47+
| `--debug[=<group>]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. |
48+
| `--prompt[=<assoc>]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. |
49+
| `--quiet` | Suppress informational messages. |

0 commit comments

Comments
 (0)