docs: document SHELL_VERBOSITY environment variable#10678
docs: document SHELL_VERBOSITY environment variable#10678radoering merged 2 commits intopython-poetry:mainfrom
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideDocuments the SHELL_VERBOSITY environment variable as an alternative way to control CLI verbosity, including mapping values to existing verbosity flags and providing an example for CI/CD usage. Flow diagram for choosing verbosity configuration methodflowchart TD
A[Need_to_change_Poetry_CLI_verbosity] --> B{Can_you_modify_command_line_arguments?}
B -->|Yes| C[Use_-q_-v_-vv_-vvv_flags]
C --> D[Run_poetry_command]
B -->|No| E[Set_SHELL_VERBOSITY_environment_variable]
E --> F{Desired_verbosity_level}
F -->|Quiet| G[Set_SHELL_VERBOSITY_to_-1_equivalent_to_-q]
F -->|Normal| H[Set_SHELL_VERBOSITY_to_0_default]
F -->|Verbose| I[Set_SHELL_VERBOSITY_to_1_equivalent_to_-v]
F -->|More_verbose| J[Set_SHELL_VERBOSITY_to_2_equivalent_to_-vv]
F -->|Debug| K[Set_SHELL_VERBOSITY_to_3_equivalent_to_-vvv]
G --> L[Run_poetry_command_without_flags]
H --> L
I --> L
J --> L
K --> L
D --> M[Observe_output_at_selected_verbosity]
L --> M
File-Level Changes
Assessment against linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Deploy preview for website ready! ✅ Preview Built with commit f97afb7. |
|
Hi, I’m new to contributing but would like to work on this documentation update. |
Thanks for the offer, but that is not necessary in this case. I think I will just remove the example and merge it. |
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 python-poetry#7601 --- Ahmed Adel Bakr Alderai
7a0163f to
f97afb7
Compare
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Summary
This PR adds documentation for the
SHELL_VERBOSITYenvironment variable as requested in #7601.Changes
Added a note to the Global Options section in
docs/cli.mdthat:SHELL_VERBOSITYas an alternative to-v/-vv/-vvvflagsContext
From the issue discussion, @Secrus (maintainer) confirmed:
This feature is inherited from the Cleo library and is particularly useful in environments like dh-poetry where command-line invocation is outside user control.
Closes #7601
Ahmed Adel Bakr Alderai
Summary by Sourcery
Documentation: