docs & slightly nicer interface for reporting scripts

leondz / garak

LLM vulnerability scanner

https://discord.gg/uVch4puUCs

Apache License 2.0

1.28k stars 147 forks source link

docs & slightly nicer interface for reporting scripts #356

Open leondz opened 9 months ago

leondz commented 9 months ago

[ ] use argparse w help instead of just sys.argv[1]
[ ] docs for the reporting
[ ] output html to a file, maybe based on the report, instead of stdout
[ ] make html report sections collapsible
[ ] add meta info to html report
[ ] add project link to html report
[ ] mention in main docs that reporting exists

drazvan commented 9 months ago

I recommend this for the CLI: https://typer.tiangolo.com/ (instead of argparse).

leondz commented 9 months ago

thanks, there's a lot that argparse doesn't do well. it looks nice so far, and the reporting scripts are probably great place to trial it before introducing it in the main cli module