Skip to content

Commit 67d904a

Browse files
Code style changes for command line example
1 parent 2dd29d4 commit 67d904a

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -65,37 +65,37 @@ All the binaries are available in the [release](https://github.com/thomaspoignan
6565
## Install using Homebrew (mac and linux)
6666
If you are using Homebrew package manager, you can install api-scenario with Homebrew.
6767

68-
```shell script
68+
```console
6969
brew tap thomaspoignant/homebrew-tap
7070
brew install api-scenario
7171
```
7272

7373
## Install using Scoop (windows)
7474

7575
If you are on Windows and using scoop package manager, you can install api-scenario with [Scoop](https://scoop.sh/).
76-
```shell script
76+
```console
7777
scoop bucket add org https://github.com/thomaspoignant/scoop.git
7878
scoop install api-scenario
7979
```
8080

8181
## Install using .deb file (linux)
8282
If you prefer to use directly the `.deb` file to install in your debian like linux distribution.
8383
_Don't forget to set the correct version number._
84-
```shell script
84+
```console
8585
wget https://github.com/thomaspoignant/api-scenario/releases/download/vX.X.X/api-scenario_X.X.X_Tux_64-bit.deb && dpkg -i api-scenario_*.deb
8686
```
8787

8888
## Install using .rpm file (linux)
8989
If you prefer to use directly the `.rpm` file to install in your centos/fedora like linux distribution.
9090
_Don't forget to set the correct version number._
91-
```shell script
91+
```console
9292
wget https://github.com/thomaspoignant/api-scenario/releases/download/vX.X.X/api-scenario_X.X.X_Tux_64-bit.rpm && rpm -i api-scenario_*.rpm
9393
```
9494

9595
## Use docker image
9696
To use the last version of our docker image you can pull `thomaspoignant/api-scenario:latest`.
9797

98-
```shell script
98+
```console
9999
docker pull thomaspoignant/api-scenario:latest
100100
```
101101

@@ -112,15 +112,15 @@ Available images are:
112112
# Command line usage
113113

114114
## Version
115-
```shell script
115+
```console
116116
$ 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

123-
```shell script
123+
```console
124124
$ api-scenario run --scenario="./scenario.json"
125125
```
126126

@@ -144,7 +144,7 @@ You just have to add the option `--output-file="<your file location>"` and it wi
144144
_(If you prefer `YAML` result add `--output-format=YAML`)_.
145145

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

@@ -241,7 +241,7 @@ We manipulate different concepts here.
241241

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))_.
244-
```shell script
244+
```console
245245
$ 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
@@ -458,7 +458,7 @@ should be stored in an Initial Variable.
458458
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.
461-
```shell script
461+
```console
462462
$ ./api-scenario run -F your_file.json --variable="baseUrl:http://www.google.com/" -V "token:token1234"
463463
```
464464

@@ -469,7 +469,7 @@ Overriding headers works the same as [global variables](#global-variables).
469469
You can add a header for all your requests by using the option `--header` or `-H`, it will add or override the header
470470
for all requests.
471471

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

0 commit comments

Comments
 (0)