From a28a8b261001cf212a3108eb683b803d9c069723 Mon Sep 17 00:00:00 2001 From: Ahmed Adel Date: Thu, 1 Jan 2026 01:50:43 +0000 Subject: [PATCH 1/2] docs: document SHELL_VERBOSITY environment variable Add documentation explaining how to set verbosity level using the SHELL_VERBOSITY environment variable. This is useful in CI/CD pipelines or scripts where command-line arguments cannot be easily modified. The note includes: - Table showing verbosity levels and their equivalents - Example usage for setting debug output Closes #7601 --- Ahmed Adel Bakr Alderai --- docs/cli.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/cli.md b/docs/cli.md index 89c028fb672..93d5c46207c 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -21,6 +21,25 @@ then `--help` combined with any of those can give you more information. ## Global Options * `--verbose (-v|vv|vvv)`: Increase the verbosity of messages: "-v" for normal output, "-vv" for more verbose output and "-vvv" for debug. + +{{% note %}} +You can also set the verbosity level using the `SHELL_VERBOSITY` environment variable. +This is useful in CI/CD pipelines or scripts where you cannot easily modify command-line arguments. + +| Value | Equivalent | Description | +|-------|------------|-------------| +| `-1` | `-q` | Quiet mode | +| `0` | (default) | Normal output | +| `1` | `-v` | Verbose output | +| `2` | `-vv` | More verbose output | +| `3` | `-vvv` | Debug output | + +For example, to enable debug output: +```bash +export SHELL_VERBOSITY=3 +poetry install +``` +{{% /note %}} * `--help (-h)` : Display help information. * `--quiet (-q)` : Do not output any message. * `--ansi`: Force ANSI output. From f97afb79639cc8ce3478e7215c23f77680118934 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Randy=20D=C3=B6ring?= <30527984+radoering@users.noreply.github.com> Date: Mon, 19 Jan 2026 16:47:50 +0100 Subject: [PATCH 2/2] remove example and pretty-format --- docs/cli.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/docs/cli.md b/docs/cli.md index 93d5c46207c..db9e28be603 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -26,20 +26,16 @@ then `--help` combined with any of those can give you more information. You can also set the verbosity level using the `SHELL_VERBOSITY` environment variable. This is useful in CI/CD pipelines or scripts where you cannot easily modify command-line arguments. -| Value | Equivalent | Description | -|-------|------------|-------------| -| `-1` | `-q` | Quiet mode | -| `0` | (default) | Normal output | -| `1` | `-v` | Verbose output | -| `2` | `-vv` | More verbose output | -| `3` | `-vvv` | Debug output | +| Value | Equivalent | Description | +|--------|------------|---------------------| +| `-1` | `-q` | Quiet mode | +| `0` | (default) | Normal output | +| `1` | `-v` | Verbose output | +| `2` | `-vv` | More verbose output | +| `3` | `-vvv` | Debug output | -For example, to enable debug output: -```bash -export SHELL_VERBOSITY=3 -poetry install -``` {{% /note %}} + * `--help (-h)` : Display help information. * `--quiet (-q)` : Do not output any message. * `--ansi`: Force ANSI output.