Skip to content

Commit 353ac23

Browse files
committed
Add README
1 parent b3c4118 commit 353ac23

File tree

1 file changed

+113
-0
lines changed

1 file changed

+113
-0
lines changed

README.md

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
Please is a utility for making and receiving web requests and parsing and reformatting the common data formats that are sent over them.
2+
3+
## Usage
4+
5+
```
6+
please [command]
7+
8+
Available Commands:
9+
help Help about any command
10+
identify Identify the format of some structured data from FILENAME or stdin if omitted
11+
parse Parse and convert structured data from FILENAME or stdin if omitted
12+
request Send a web request to a url and print the response
13+
respond Listen for an HTTP request and respond to it
14+
serve Serve the contents of PATH (current directory if omitted) through a simple web server
15+
```
16+
17+
## Please Identify
18+
19+
Identify the format of some structured data from FILENAME or stdin if omitted
20+
21+
```
22+
Usage:
23+
please identify (FILENAME) [flags]
24+
25+
Flags:
26+
-h, --help help for identify
27+
```
28+
29+
## Please parse
30+
31+
Parse and converted structured data from FILENAME or stdin if omitted.
32+
33+
```
34+
Input formats:
35+
csv
36+
html
37+
json
38+
mime
39+
query
40+
toml
41+
xml
42+
yaml
43+
44+
Output formats:
45+
bash
46+
dot
47+
json
48+
query
49+
toml
50+
xml
51+
yaml
52+
53+
## Please parse
54+
55+
Usage:
56+
please parse (FILENAME) [flags]
57+
58+
Flags:
59+
-f, --from string input format (see please help parse for formats) (default "auto")
60+
-h, --help help for parse
61+
-q, --query string JMESPath query
62+
-t, --to string output format (see please help parse for formats) (default "auto")
63+
```
64+
65+
## Please Request
66+
67+
Send a web request to a url and print the response
68+
69+
```
70+
Usage:
71+
please request [method] [url] [flags]
72+
73+
Aliases:
74+
request, get, post, put, delete
75+
76+
Flags:
77+
-b, --body string Filename to read the request body from. Use - or omit for stdin.
78+
-h, --help help for request
79+
-i, --include-headers Read headers from the request body
80+
-v, --verbose Output response status line and headers
81+
```
82+
83+
## Please Respond
84+
85+
Listen for an HTTP request and respond to it
86+
87+
```
88+
Usage:
89+
please respond [flags]
90+
91+
Flags:
92+
-a, --address string Address to listen on
93+
-b, --body string Filename to read the response body from. Use - or omit for stdin
94+
-h, --help help for respond
95+
-i, --include-headers Read headers from the response body
96+
-p, --port int Port to listen on (default 8000)
97+
-s, --status int Status code to respond with (default 200)
98+
-v, --verbose Output request headers
99+
```
100+
101+
## Please Serve
102+
103+
Serve the contents of PATH (current directory if omitted) through a simple web server
104+
105+
```
106+
Usage:
107+
please serve (PATH) [flags]
108+
109+
Flags:
110+
-a, --address string Address to listen on
111+
-h, --help help for serve
112+
-p, --port int Post to listen on (default 8000)
113+
```

0 commit comments

Comments
 (0)