-
-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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.
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
invoke-webrequest: add page #8177
Changes from all commits
5111020
6375904
a7bf2bc
7956ccd
2f800ec
107ae25
8654886
9c040c4
05f6131
6f2be83
78eff48
9c3b5a8
ae63398
3c7dfb8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# curl | ||
|
||
> In PowerShell, this command may be an alias of `Invoke-WebRequest` when the original `curl` program (<https://curl.se>) is not properly installed. | ||
|
||
- Check whether `curl` is properly installed by printing its version number. If this command evaluates into an error, PowerShell may have substituted this command with `Invoke-WebRequest`: | ||
|
||
`curl --version` | ||
|
||
- View documentation for the original `curl` command: | ||
|
||
`tldr curl -p common` | ||
|
||
- View documentation for PowerShell's `Invoke-WebRequest` command: | ||
|
||
`tldr invoke-webrequest` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Invoke-WebRequest | ||
|
||
> Performs a HTTP/HTTPS request to the Web. | ||
> This command can only be used through PowerShell. | ||
> More information: <https://docs.microsoft.com/powershell/module/microsoft.powershell.utility/invoke-webrequest>. | ||
|
||
- Download the contents of a URL to a file: | ||
|
||
`Invoke-WebRequest {{http://example.com}} -OutFile {{filename}}` | ||
|
||
- Send form-encoded data (POST request of type `application/x-www-form-urlencoded`): | ||
|
||
`Invoke-WebRequest -Method Post -Body @{ name='bob' } {{http://example.com/form}}` | ||
|
||
- Send a request with an extra header, using a custom HTTP method: | ||
|
||
`Invoke-WebRequest -Headers {{@{ X-My-Header = '123' }}} -Method {{PUT}} {{http://example.com}}` | ||
|
||
- Send data in JSON format, specifying the appropriate content-type header: | ||
|
||
`Invoke-WebRequest -Body {{'{"name":"bob"}'}} -ContentType 'application/json' {{http://example.com/users/1234}}` | ||
|
||
- Pass a username and password for server authentication: | ||
|
||
`Invoke-WebRequest -Headers @{ Authorization = "Basic "+ [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes("myusername:mypassword")) } {{http://example.com}}` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# iwr | ||
|
||
> This command is an alias of `Invoke-WebRequest` in PowerShell. | ||
|
||
- View documentation for the original command: | ||
|
||
`tldr invoke-webrequest` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# wget | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same here. Let's remove these There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I wrote these two pages for two reasons. First is the fact that in PowerShell for Windows, both commands will be substituted with and similarly, executing As far as I know there are some edge cases where a command documentation is split between Ah I forgot that the original documentation should be accessed with There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oh I see, thanks for clarifying this. This is a rather confusing situation, isn't it?
With this in mind, your solution here seems to be the best option. Thanks for explaining - not being a Windows user I didn't understand at first. |
||
|
||
> In PowerShell, this command may be an alias of `Invoke-WebRequest` when the original `wget` program (<https://www.gnu.org/software/wget>) is not properly installed. | ||
|
||
- Check whether `wget` is properly installed by printing its version number. If this command evaluates into an error, PowerShell may have substituted this command with `Invoke-WebRequest`: | ||
|
||
`curl --version` | ||
|
||
- View documentation for the original `wget` command: | ||
|
||
`tldr wget -p common` | ||
|
||
- View documentation for PowerShell's `Invoke-WebRequest` command: | ||
|
||
`tldr invoke-webrequest` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will overwrite the existing
curl
page in thecommon
platform.