Skip to content

Commit e152fd7

Browse files
committed
docs: testcase variables at cli added
1 parent a2c5489 commit e152fd7

1 file changed

Lines changed: 15 additions & 12 deletions

File tree

docs/references/concepts.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Core concepts and usage
2+
title: Command-line reference
33
---
44

55
This page describes some key concepts before you use **`CHKware`**.
@@ -17,30 +17,33 @@ There are two parts to **`CHKware`** tool.
1717

1818
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

20-
**[Options]**
20+
#### Options
2121

22-
- `--result, -r` <small>**_optional_**</small>: When you put this option, the you'll see only the result.
23-
- `--no-format, -nf` <small>**_optional_**</small>: When you put this option, the result will not be formatter.
22+
- `--result, -r` <small>**_optional_**</small>: When you put this option, the you'll see only the result.
23+
- `--no-format, -nf` <small>**_optional_**</small>: When you put this option, the result will not be formatter.
2424

25-
**[Arguments]**
25+
#### Arguments
2626

27-
- `[FILE].chk` <small>**_required_**</small>: File that you want to execute.
28-
- `[VARIABLEn=VALUEn]` <small>**_optional_**</small>: Pass variables from command-line. format: _variableName1=value1_[space]_variableName2=value2_
27+
- `[FILE].chk` <small>**_required_**</small>: File that you want to execute.
28+
- `[VARIABLEn=VALUEn]` <small>**_optional_**</small>: Pass variables from command-line. format: _variableName1=value1_[space]_variableName2=value2_
29+
30+
---
2931

3032
- `chk testcase [Options] [FILE].chk`
3133

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

3436
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).
3537

36-
**[Options]**
38+
#### Options
3739

38-
- `--result, -r` <small>**_optional_**</small>: When you put this option, the you'll see only the result.
39-
- `--no-format, -nf` <small>**_optional_**</small>: When you put this option, the result will not be formatter.
40+
- `--result, -r` <small>**_optional_**</small>: When you put this option, the you'll see only the result.
41+
- `--no-format, -nf` <small>**_optional_**</small>: When you put this option, the result will not be formatter.
4042

41-
**[Arguments]**
43+
#### Arguments
4244

43-
- `[FILE].chk` <small>**_required_**</small>: File that you want to execute.
45+
- `[FILE].chk` <small>**_required_**</small>: File that you want to execute.
46+
- `[VARIABLEn=VALUEn]` <small>**_optional_**</small>: Pass variables from command-line. format: _variableName1=value1_[space]_variableName2=value2_
4447

4548
### Specification files
4649

0 commit comments

Comments
 (0)