Skip to content

Commit 725b8ee

Browse files
committed
Update cli ref
1 parent fb1fa0d commit 725b8ee

1 file changed

Lines changed: 11 additions & 5 deletions

File tree

docs/references/concepts.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,32 +11,38 @@ There are two parts to **`CHKware`** tool.
1111

1212
### Supported sub-commands
1313

14-
- `chk http [--result] [FILE].chk`
14+
- `chk http [Options] [FILE].chk [VARIABLEn=VALUEn]`
1515

1616
This sub command runs a file written in [http specification file](http-reference) format.
1717

18-
After you execute this command `chk` should make request by given request format, and display the response. You can also customize the response with `request.result` key. see [usage](/examples/http-examples#request-with-form) and [documentation](/references/http-reference).
18+
After you execute this command `chk` should make request by given request format, and display the response. You can also customize the response with `expose` key. see [usage](/examples/http-examples#request-with-form) and [documentation](/references/http-reference).
1919

2020
**[Options]**
21-
- `--result` <small>***optional***</small>: When you put this option, the you'll see only the result.
21+
- `--result, -r` <small>***optional***</small>: When you put this option, the you'll see only the result.
22+
- `--no-format, -nf` <small>***optional***</small>: When you put this option, the result will not be formatter.
2223

2324
**[Arguments]**
2425
- `[FILE].chk` <small>***required***</small>: File that you want to execute.
26+
- `[VARIABLEn=VALUEn]` <small>***optional***</small>: Pass variables from command-line. format: _variableName1=value1_[space]_variableName2=value2_
2527

26-
- `chk testcase [FILE].chk`
28+
- `chk testcase [Options] [FILE].chk`
2729

2830
This sub command runs a file written in [testcase specification file](testcase-reference) format.
2931

3032
After you execute this command `chk` should re-use `http` utility to request as per given structure on the file, execute test assertions, and display the result of the assertions. See [example](/examples/testcase-examples).
3133

34+
**[Options]**
35+
- `--result, -r` <small>***optional***</small>: When you put this option, the you'll see only the result.
36+
- `--no-format, -nf` <small>***optional***</small>: When you put this option, the result will not be formatter.
37+
3238
**[Arguments]**
3339
- `[FILE].chk` <small>***required***</small>: File that you want to execute.
3440

3541
### Specification files
3642

3743
Test specification files are written in YAML, having file extension `.chk`. So, before you start writing any specification file, you MUST have a proper knowledge of YAML, see [YAML cheatsheet](https://quickref.me/yaml). We are using this specific extension (`.chk`) so these files do not make you confuse in typical project layout.
3844

39-
> In the future evolution path of **chkware** we are going to introduce more and more specification options and specification types and versions.
45+
> In the future evolution path of **CHKware** we are going to introduce more and more specification options and specification types and versions.
4046
4147
- [Http specification file](http-reference)
4248
- [Testcase specification file](testcase-reference)

0 commit comments

Comments
 (0)