@@ -38,7 +38,18 @@ will have access to request specific commands.
3838Another important thing to know is input options are denoted by
3939` {name} ` and can be anywhere in the url, headers, or body.
4040
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
4253This section shows how to create a request, define variables, and
4354add extractors.
4455
@@ -57,7 +68,7 @@ or `$HOME/.repost/$WORKSPACE_NAME.db`.
5768** Note:** If you forget what command does what, use ` help ` or ` --help `
5869for more information about the available commands and flags.
5970
60- #### Setting a workspace
71+ ### Setting a workspace
6172Your current workspace is where all of your data will be saved.
6273Repost starts with the default workspace: ` repost ` , but we can
6374change that using ` set workspace <workspace_name> ` .
@@ -79,7 +90,7 @@ To show the available workspaces, use `show workspaces`.
7990 +-----------+
8091```
8192
82- #### Create a request
93+ ### Create a request
8394The minimum request has a name and a URL. Headers can be added with
8495` -H ` and a body with ` -d ` . If the argument to ` -d ` starts with ` @ ` ,
8596repost 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`.
119130
120131```
121132
122- #### Set options
133+ ### Set options
123134From the request state, we can use ` set option ` to set the value for the request.
124135
125136```
@@ -152,7 +163,7 @@ Here we see the current value, and the planned requests if we were
152163to run it. You may set multiple values for the same input option by
153164providing more values on the command line.
154165
155- #### Run a request
166+ ### Run a request
156167There are two ways to run a request. If you are in a request state, simply using
157168` run ` will execute the current request. The other way is to specify the request
158169name to run.
@@ -184,7 +195,7 @@ name to run.
184195}
185196```
186197
187- #### Define a variable
198+ ### Define a variable
188199Variables are environment specific, and should generally match your
189200request's input options. When you are in an environment, the value
190201of the variable will automatically be populated in the input option.
@@ -215,7 +226,7 @@ Now we can set an environment using `set environment`. Additionally,
215226Note that when we set the environment, our input option gets updated
216227to the value of the variable.
217228
218- #### Add extractors
229+ ### Add extractors
219230Extractors may be added in the request state. The command ` extract `
220231is used to add it as an output option to the request. Extractors will
221232try 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.
227238
228239Currently, only JSON extraction is supported.
229240
230- ##### JSON query expression
241+ #### JSON query expression
231242The simplified language is ` . ` separated sub-fields and ` [] ` for
232243accessing arrays. The value inside ` [] ` must be an integer OR ` * `
233244meaning all array objects.
0 commit comments