Skip to content

Commit 55987c7

Browse files
Update README.md
1 parent 67d904a commit 55987c7

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -113,15 +113,15 @@ Available images are:
113113

114114
## Version
115115
```console
116-
$ api-scenario version
116+
api-scenario version
117117
# 0.1.0
118118
```
119119

120120
## Execute your scenario
121121
To execute your scenario please use the `run` options and specify your scenario file.
122122

123123
```console
124-
$ api-scenario run --scenario="./scenario.json"
124+
api-scenario run --scenario="./scenario.json"
125125
```
126126

127127
There are several options you can use with this command:
@@ -145,7 +145,7 @@ _(If you prefer `YAML` result add `--output-format=YAML`)_.
145145

146146
**Example:**
147147
```console
148-
$ api-scenario run --scenario="./scenario.json" --output-file="<your file location>" --output-format=YAML
148+
api-scenario run --scenario="./scenario.json" --output-file="<your file location>" --output-format=YAML
149149
```
150150

151151
---
@@ -242,7 +242,7 @@ We manipulate different concepts here.
242242

243243
Now the first scenario is build, we can run it _(see complete scenario: [YAML](examples/first-test.yml) / [JSON](examples/first-test.json))_.
244244
```console
245-
$ api-scenario run --scenario="examples/first-test.json" --variable="baseUrl:https://reqres.in"
245+
api-scenario run --scenario="examples/first-test.json" --variable="baseUrl:https://reqres.in"
246246
```
247247
What we are doing is here is running our scenario file, and we ask to replace every occurrence
248248
of `{{baseUrl}}` by `https://reqres.in`.
@@ -459,7 +459,7 @@ Once defined, the variable is available to all requests within the test.
459459

460460
To add a variable just use the option `--variable` or `-V` and specify the `key:value` of this variable.
461461
```console
462-
$ ./api-scenario run -F your_file.json --variable="baseUrl:http://www.google.com/" -V "token:token1234"
462+
./api-scenario run -F your_file.json --variable="baseUrl:http://www.google.com/" -V "token:token1234"
463463
```
464464

465465
__Note that if you create a variable in a step with the same name of a global variable it will override it.__
@@ -470,7 +470,7 @@ You can add a header for all your requests by using the option `--header` or `-H
470470
for all requests.
471471

472472
```console
473-
$ ./api-scenario run -F your_file.json --header="Content-Type:application/json" -H "Authorization: Bearer Token123"
473+
./api-scenario run -F your_file.json --header="Content-Type:application/json" -H "Authorization: Bearer Token123"
474474
```
475475

476476
## Built-in Variables and Functions

0 commit comments

Comments
 (0)