Skip to content

Commit

Permalink
docs: add docs about config command
Browse files Browse the repository at this point in the history
  • Loading branch information
KuznetsovRoman committed Jan 15, 2025
1 parent cd5fb1f commit debe90c
Show file tree
Hide file tree
Showing 2 changed files with 84 additions and 0 deletions.
42 changes: 42 additions & 0 deletions docs/command-line/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -533,6 +533,48 @@ Prints out information about the command and its options.
testplane list-browsers --help
```
## The `config` Command
This command is used to retrieve all configuration values of Testplane, including default values and overridden by environment variables ones.
```bash
> npx testplane config --help
Usage: config [options]
Outputs Testplane config (including default and overriden by environment variables values)
Options:
-c, --config <path> path to configuration file
--space <count> white spaces count to insert into the JSON output (default: 0)
-h, --help output usage information
```
For example:
```bash
npx testplane config --space 4
```
### Options {#config-options}
#### Space {#config-space}
Specify the number of spaces used for formatting the human-readable output of the command.
```bash
testplane config --space 4
```
#### Help {#config-help}
Outputs information about the command and its options.
```bash
testplane config --help
```
## `install-deps` command {#install-deps}
This command is a part of the guide [How to launch Testplane in the local browser](/docs/v8/guides/local-browsers).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -535,6 +535,48 @@ testplane list-browsers --format json
testplane list-browsers --help
```
## Команда `config`
Команда для получения всех значений конфигурации Testplane, включая значения по умолчанию и перезаписанные значения с помощью переменных среды.
```bash
> npx testplane config --help
Usage: config [options]
Outputs Testplane config (including default and overriden by environment variables values)
Options:
-c, --config <path> path to configuration file
--space <count> white spaces count to insert into the JSON output (default: 0)
-h, --help output usage information
```
Например:
```bash
npx testplane config --space 4
```
### Опции {#config-options}
#### Space {#config-space}
Укажите количество пробелов, используемых для форматирования человекочитаемого вывода команды.
```bash
testplane config --space 4
```
#### Help {#config-help}
Выводит информацию команде и ее опциях.
```bash
testplane config --help
```
## Команда `install-deps` {#install-deps}
Эта команда является частью рецепта [Как запустить Testplane в локальном браузере](/docs/v8/guides/local-browsers).
Expand Down

0 comments on commit debe90c

Please sign in to comment.