Skip to content

Commit

Permalink
Explain these examples in more detail
Browse files Browse the repository at this point in the history
  • Loading branch information
danielbachhuber committed Jul 19, 2016
1 parent 4e5dffd commit 786e49f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Target a specific WordPress install with `--path=<path>`, `--ssh=<host>`, or `--

```
# The `--path=<path>` global parameter tells WP-CLI to interact with a WordPress install at a given path.
# Because this is a stock WordPress install, you see the posts, pages, and other resources you'd expect to see.
$ wp --path=/srv/www/wordpress-develop.dev/src rest
usage: wp rest attachment <command>
or: wp rest category <command>
Expand All @@ -40,6 +41,7 @@ usage: wp rest attachment <command>
or: wp rest user <command>
# The `--http=<domain>` global parameter tells WP-CLI to auto-discover endpoints over HTTP.
# Because Wired has some custom post types, they're automatically registered as WP-CLI commands.
$ wp --http=www.wired.com rest
usage: wp rest attachment <command>
or: wp rest category <command>
Expand All @@ -61,6 +63,7 @@ usage: wp rest attachment <command>
or: wp rest video <command>
# The `--ssh=<host>` global parameter proxies command execution to a remote WordPress install.
# Because runcommand has a completely custom data model, you can only interact with commands, excerpts, and sparks.
$ wp --ssh=runcommand.io rest
usage: wp rest command <command>
or: wp rest excerpt <command>
Expand Down
3 changes: 3 additions & 0 deletions bin/readme-stubs/using.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Target a specific WordPress install with `--path=<path>`, `--ssh=<host>`, or `--

```
# The `--path=<path>` global parameter tells WP-CLI to interact with a WordPress install at a given path.
# Because this is a stock WordPress install, you see the posts, pages, and other resources you'd expect to see.
$ wp --path=/srv/www/wordpress-develop.dev/src rest
usage: wp rest attachment <command>
or: wp rest category <command>
Expand All @@ -25,6 +26,7 @@ usage: wp rest attachment <command>
or: wp rest user <command>
# The `--http=<domain>` global parameter tells WP-CLI to auto-discover endpoints over HTTP.
# Because Wired has some custom post types, they're automatically registered as WP-CLI commands.
$ wp --http=www.wired.com rest
usage: wp rest attachment <command>
or: wp rest category <command>
Expand All @@ -46,6 +48,7 @@ usage: wp rest attachment <command>
or: wp rest video <command>
# The `--ssh=<host>` global parameter proxies command execution to a remote WordPress install.
# Because runcommand has a completely custom data model, you can only interact with commands, excerpts, and sparks.
$ wp --ssh=runcommand.io rest
usage: wp rest command <command>
or: wp rest excerpt <command>
Expand Down

0 comments on commit 786e49f

Please sign in to comment.