Skip to content

Commit 369a37d

Browse files
authored
Merge pull request #1 from aspnet/tlmii/readme-update
Update README.md
2 parents 7d14089 + f41d4a7 commit 369a37d

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.md

+43
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,46 @@ Repo for HttpRepl tool.
66
## Building
77

88
To build this repo, run the `build.cmd` or `build.sh` in the root of this repo. This repo uses the .NET [Arcade toolset](https://github.com/dotnet/arcade).
9+
10+
## Usage
11+
12+
From the in-product help:
13+
```
14+
HTTP Commands:
15+
Use these commands to execute requests against your application.
16+
17+
GET Issues a GET request.
18+
POST Issues a POST request.
19+
PUT Issues a PUT request.
20+
DELETE Issues a DELETE request.
21+
PATCH Issues a PATCH request.
22+
HEAD Issues a HEAD request.
23+
OPTIONS Issues an OPTIONS request.
24+
25+
set header Sets or clears a header for all requests. e.g. `set header content-type application/json`
26+
27+
28+
Navigation Commands:
29+
The REPL allows you to navigate your URL space and focus on specific APIS that you are working on.
30+
31+
set base Set the base URI. e.g. `set base http://locahost:5000`
32+
set swagger Set the URI, relative to your base if set, of the Swagger document for this API. e.g. `set swagger /swagger/v1/swagger.json`
33+
ls Show all endpoints for the current path.
34+
cd Append the given directory to the currently selected path, or move up a path when using `cd ..`.
35+
36+
Shell Commands:
37+
Use these commands to interact with the REPL shell.
38+
39+
clear Removes all text from the shell.
40+
echo [on/off] Turns request echoing on or off, show the request that was mode when using request commands.
41+
exit Exit the shell.
42+
43+
REPL Customization Commands:
44+
Use these commands to customize the REPL behavior..
45+
46+
pref [get/set] Allows viewing or changing preferences, e.g. 'pref set editor.command.default 'C:\Program Files\Microsoft VS Code\Code.exe'`
47+
run Runs the script at the given path. A script is a set of commands that can be typed with one command per line.
48+
ui Displays the swagger UI page, if available, in the default browser.
49+
50+
Use help <COMMAND> to learn more details about individual commands. e.g. `help get`
51+
```

0 commit comments

Comments
 (0)