Skip to content

docs: document SHELL_VERBOSITY environment variable #10678

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.

Sign up for GitHub

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

Open
Ahmed-AdelB wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −0
Open

docs: document SHELL_VERBOSITY environment variable #10678

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions docs/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Comment on lines +37 to +41
Copy link
Member

@radoering radoering Jan 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I would omit the example because in this case you can just use command-line arguments and I hope people who cannot use command-line arguments are able to figure out for themselves how to set an environment variable.

{{% /note %}}
* `--help (-h)` : Display help information.
* `--quiet (-q)` : Do not output any message.
* `--ansi`: Force ANSI output.
Expand Down