pyupio/safety

Documentation: `--debug`

Closed this issue · 2 comments

Zeckie commented
  • safety version: 3.2.2
  • Python version: 3.12
  • Operating System: Windows

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                                                           │
│
...
dylanpulver commented

Thank you @Zeckie for this issue report! The fix has now been merged in: #552
To close this issue, please let us know that the bug is solved when using the latest code!

Zeckie commented

Yes, that seems to have fixed it (I installed from git+https://github.com/pyupio/safety@main). Thanks