Skip to content
This repository was archived by the owner on Sep 17, 2022. It is now read-only.

Commit c75b8f8

Browse files
iv-piv-p
committed
Added docs
1 parent e5f8807 commit c75b8f8

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

‎docs/cli/check.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ Check takes all the transactions that you have specified in the yaml. The steps
88

99
## Flags
1010

11-
| Flag | Short | Required | Default | Description |
12-
| :-------- | :---- | :------- | :---------- | :-------------------------------------------------------------------------------- |
13-
| --config | -c | no | ./apid.yaml | The config file. If a folder is provided will recursively load all `*.yaml` files |
14-
| --timings | -t | no | false | Display the request timings, like DNS lookup, TCP connect, TLS handshake, etc |
11+
| Flag | Short | Required | Default | Description |
12+
| :------------ | :---- | :------- | :---------- | :-------------------------------------------------------------------------------- |
13+
| --config | -c | no | ./apid.yaml | The config file. If a folder is provided will recursively load all `*.yaml` files |
14+
| --timings | -t | no | false | Display the request timings, like DNS lookup, TCP connect, TLS handshake, etc |
15+
| --parallelism | -p | no | 10 | Number of transactions to be run in parallel |
1516

1617
# Examples
1718

‎docs/cli/cloud/check.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,13 @@ Check takes all the transactions that you have specified in the yaml. The steps
88

99
## Flags
1010

11-
| Flag | Short | Required | Default | Description |
12-
| :-------- | :---- | :------- | :---------- | :---------------------------------------------------------------------------------------------------------------------------- |
13-
| --key | -k | yes | | [Your API key](../cloud/README.md), this can also be injected via the `APID_KEY` environment variable. Flag takes precedence. |
14-
| --region | -r | no | washington | The location to run the tests from, a list or regions can be found [here](../cloud/README.md) |
15-
| --config | -c | no | ./apid.yaml | The config file. If a folder is provided will recursively load all `*.yaml` files |
16-
| --timings | -t | no | false | Display the request timings, like DNS lookup, TCP connect, TLS handshake, etc |
11+
| Flag | Short | Required | Default | Description |
12+
| :------------ | :---- | :------- | :---------- | :---------------------------------------------------------------------------------------------------------------------------- |
13+
| --key | -k | yes | | [Your API key](../cloud/README.md), this can also be injected via the `APID_KEY` environment variable. Flag takes precedence. |
14+
| --region | -r | no | washington | The location to run the tests from, a list or regions can be found [here](../cloud/README.md) |
15+
| --config | -c | no | ./apid.yaml | The config file. If a folder is provided will recursively load all `*.yaml` files |
16+
| --timings | -t | no | false | Display the request timings, like DNS lookup, TCP connect, TLS handshake, etc |
17+
| --parallelism | -p | no | 10 | Number of transactions to be run in parallel |
1718

1819
# Examples
1920

0 commit comments

Comments
 (0)