@@ -38,7 +38,18 @@ will have access to request specific commands.
38
38
Another important thing to know is input options are denoted by
39
39
` {name} ` and can be anywhere in the url, headers, or body.
40
40
41
- ### Quick start
41
+ ## Installation
42
+ Currently the only way to install this is to build from source and
43
+ run the executable. You will need the Rust build tools (specifically
44
+ ` cargo ` ).
45
+
46
+ ```
47
+ » git clone https://github.com/mcastorina/repost && cd repost
48
+ » make release
49
+ » ls -l ./target/release/repost
50
+ ```
51
+
52
+ ## Quick start
42
53
This section shows how to create a request, define variables, and
43
54
add extractors.
44
55
@@ -57,7 +68,7 @@ or `$HOME/.repost/$WORKSPACE_NAME.db`.
57
68
** Note:** If you forget what command does what, use ` help ` or ` --help `
58
69
for more information about the available commands and flags.
59
70
60
- #### Setting a workspace
71
+ ### Setting a workspace
61
72
Your current workspace is where all of your data will be saved.
62
73
Repost starts with the default workspace: ` repost ` , but we can
63
74
change that using ` set workspace <workspace_name> ` .
@@ -79,7 +90,7 @@ To show the available workspaces, use `show workspaces`.
79
90
+-----------+
80
91
```
81
92
82
- #### Create a request
93
+ ### Create a request
83
94
The minimum request has a name and a URL. Headers can be added with
84
95
` -H ` and a body with ` -d ` . If the argument to ` -d ` starts with ` @ ` ,
85
96
repost will try to find the file to use as its body. Use ` {option-name} `
@@ -119,7 +130,7 @@ our current request and view the `info`.
119
130
120
131
```
121
132
122
- #### Set options
133
+ ### Set options
123
134
From the request state, we can use ` set option ` to set the value for the request.
124
135
125
136
```
@@ -152,7 +163,7 @@ Here we see the current value, and the planned requests if we were
152
163
to run it. You may set multiple values for the same input option by
153
164
providing more values on the command line.
154
165
155
- #### Run a request
166
+ ### Run a request
156
167
There are two ways to run a request. If you are in a request state, simply using
157
168
` run ` will execute the current request. The other way is to specify the request
158
169
name to run.
@@ -184,7 +195,7 @@ name to run.
184
195
}
185
196
```
186
197
187
- #### Define a variable
198
+ ### Define a variable
188
199
Variables are environment specific, and should generally match your
189
200
request's input options. When you are in an environment, the value
190
201
of the variable will automatically be populated in the input option.
@@ -215,7 +226,7 @@ Now we can set an environment using `set environment`. Additionally,
215
226
Note that when we set the environment, our input option gets updated
216
227
to the value of the variable.
217
228
218
- #### Add extractors
229
+ ### Add extractors
219
230
Extractors may be added in the request state. The command ` extract `
220
231
is used to add it as an output option to the request. Extractors will
221
232
try to capture a certain part of a request and save it to a variable.
@@ -227,7 +238,7 @@ or `header` to denote which part of the response to extract from.
227
238
228
239
Currently, only JSON extraction is supported.
229
240
230
- ##### JSON query expression
241
+ #### JSON query expression
231
242
The simplified language is ` . ` separated sub-fields and ` [] ` for
232
243
accessing arrays. The value inside ` [] ` must be an integer OR ` * `
233
244
meaning all array objects.
0 commit comments