Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add docs about config command #53

Merged
merged 1 commit into from
Jan 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading