Skip to content

Commit 34d640b

Browse files
committed
Updates readme
1 parent 49a90e9 commit 34d640b

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,26 @@ dotnet tool install --global https --version 0.1.0-beta
1717
Urls without a protocol, i.e., `http://` or `https://`, by default will be assigns the `https://` protocol.
1818

1919
```bash
20-
https [method] [uri] [options] [content]
20+
Usage: https <METHOD> <URI> [options] [content]
21+
22+
Submits HTTP requests. For example https put httpbin.org/put hello=world
23+
24+
Arguments:
25+
<METHOD> HTTP method, i.e., get, head, post
26+
<URI> URI to send the request to. Leaving the protocol off the URI defaults to https://
27+
28+
Options:
29+
--form Renders the content arguments as application/x-www-form-urlencoded
30+
--help Show command line help.
31+
--ignore-certificate Prevents server certificate validation.
32+
--json Renders the content arguments as application/json.
33+
--timeout <VALUE> Sets the timeout of the request using System.TimeSpan.TryParse (https://docs.microsoft.com/en-us/dotnet/api/system.timespan.parse)
34+
--version Displays the application verison.
35+
--xml <ROOT_NAME> Renders the content arguments as application/xml using the optional xml root name.
36+
37+
Content:
38+
Repeat as many content arguments to create content sent with the HTTP request. Alternatively pipe raw content send as the HTTP request content.
39+
<KEY>=<VALUE>
2140
```
2241

2342
For example `https put httpbin.org/put hello=world` will output:

0 commit comments

Comments
 (0)