Skip to content

Commit 7a0163f

Browse files
committed
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
1 parent 93baede commit 7a0163f

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/cli.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,25 @@ then `--help` combined with any of those can give you more information.
2121
## Global Options
2222

2323
* `--verbose (-v|vv|vvv)`: Increase the verbosity of messages: "-v" for normal output, "-vv" for more verbose output and "-vvv" for debug.
24+
25+
{{% note %}}
26+
You can also set the verbosity level using the `SHELL_VERBOSITY` environment variable.
27+
This is useful in CI/CD pipelines or scripts where you cannot easily modify command-line arguments.
28+
29+
| Value | Equivalent | Description |
30+
|-------|------------|-------------|
31+
| `-1` | `-q` | Quiet mode |
32+
| `0` | (default) | Normal output |
33+
| `1` | `-v` | Verbose output |
34+
| `2` | `-vv` | More verbose output |
35+
| `3` | `-vvv` | Debug output |
36+
37+
For example, to enable debug output:
38+
```bash
39+
export SHELL_VERBOSITY=3
40+
poetry install
41+
```
42+
{{% /note %}}
2443
* `--help (-h)` : Display help information.
2544
* `--quiet (-q)` : Do not output any message.
2645
* `--ansi`: Force ANSI output.

0 commit comments

Comments
 (0)