Skip to content

Commit b1ef333

Browse files
docs: add docs about config command
1 parent acd0a55 commit b1ef333

File tree

2 files changed

+84
-0
lines changed
  • docs/command-line
  • i18n/ru/docusaurus-plugin-content-docs/current/command-line

2 files changed

+84
-0
lines changed

docs/command-line/index.mdx

+42
Original file line numberDiff line numberDiff line change
@@ -533,6 +533,48 @@ Prints out information about the command and its options.
533533
testplane list-browsers --help
534534
```
535535
536+
## The `config` Command
537+
538+
This command is used to retrieve all configuration values of Testplane, including default values and overridden by environment variables ones.
539+
540+
```bash
541+
> npx testplane config --help
542+
543+
Usage: config [options]
544+
545+
Outputs Testplane config (including default and overriden by environment variables values)
546+
547+
Options:
548+
549+
-c, --config <path> path to configuration file
550+
--space <count> white spaces count to insert into the JSON output (default: 0)
551+
-h, --help output usage information
552+
```
553+
554+
For example:
555+
556+
```bash
557+
npx testplane config --space 4
558+
```
559+
560+
### Options {#config-options}
561+
562+
#### Space {#config-space}
563+
564+
Specify the number of spaces used for formatting the human-readable output of the command.
565+
566+
```bash
567+
testplane config --space 4
568+
```
569+
570+
#### Help {#config-help}
571+
572+
Outputs information about the command and its options.
573+
574+
```bash
575+
testplane config --help
576+
```
577+
536578
## `install-deps` command {#install-deps}
537579
538580
This command is a part of the guide [How to launch Testplane in the local browser](/docs/v8/guides/local-browsers).

i18n/ru/docusaurus-plugin-content-docs/current/command-line/index.mdx

+42
Original file line numberDiff line numberDiff line change
@@ -535,6 +535,48 @@ testplane list-browsers --format json
535535
testplane list-browsers --help
536536
```
537537
538+
## Команда `config`
539+
540+
Команда для получения всех значений конфигурации Testplane, включая значения по умолчанию и перезаписанные значения с помощью переменных среды.
541+
542+
```bash
543+
> npx testplane config --help
544+
545+
Usage: config [options]
546+
547+
Outputs Testplane config (including default and overriden by environment variables values)
548+
549+
Options:
550+
551+
-c, --config <path> path to configuration file
552+
--space <count> white spaces count to insert into the JSON output (default: 0)
553+
-h, --help output usage information
554+
```
555+
556+
Например:
557+
558+
```bash
559+
npx testplane config --space 4
560+
```
561+
562+
### Опции {#config-options}
563+
564+
#### Space {#config-space}
565+
566+
Укажите количество пробелов, используемых для форматирования человекочитаемого вывода команды.
567+
568+
```bash
569+
testplane config --space 4
570+
```
571+
572+
#### Help {#config-help}
573+
574+
Выводит информацию команде и ее опциях.
575+
576+
```bash
577+
testplane config --help
578+
```
579+
538580
## Команда `install-deps` {#install-deps}
539581
540582
Эта команда является частью рецепта [Как запустить Testplane в локальном браузере](/docs/v8/guides/local-browsers).

0 commit comments

Comments
 (0)