search

pyupio / safety

Safety checks Python dependencies for known security vulnerabilities and suggests the proper remediations for vulnerabilities detected.
https://safetycli.com/product/safety-cli
MIT License
1.66k stars 141 forks source link

Documentation: `--debug` #536

Open Zeckie opened 3 weeks ago

Zeckie commented 3 weeks ago

Description

The documentation for the --debug option (on website and via --help) does not currently match how it works.

image

https://docs.safetycli.com/safety-docs/safety-cli-3/available-commands-and-inputs

What I Did

> safety --debug scan
Usage: safety [OPTIONS] COMMAND [ARGS]...
Try 'safety --help' for help.

Error: Invalid value for '--debug': 'scan' is not a valid boolean.
> safety --debug true scan
2024-06-08 13:02:41,754 urllib3.connectionpool => Starting new HTTPS connection (1): auth.safetycli.com:443
2024-06-08 13:02:43,058 urllib3.connectionpool => https://auth.safetycli.com:443 "GET /.well-known/openid-configuration HTTP/1.1" 200 None
2024-06-08 13:02:43,380 urllib3.connectionpool => https://auth.safetycli.com:443 "GET /.well-known/jwks.json HTTP/1.1" 200 None
...
> safety --help
...
│ --disable-optional-telemetry                            Opt-out of sending optional telemetry data. Anonymized telemetry data will remain.     │
│                                                         Example: safety --disable-optional-telemetry scan                                      │
│ --debug                                                 Enable debug mode for detailed output.                                                 │
│                                                         Example: safety --debug scan                                                           │
│
...