Skip to content

reporting: unify command line interface for reporting analysis modules #1368

@leondz

Description

@leondz

The CLI scripts in garak.analyze don't have consistent patterns for usage. They should be aligned so that:

  • they all use argparse or typer to get parameters
  • they all have a help / description section showing e.g. garak version (check out garak.cli for a pattern)
  • command line parameter names are consistent across all the scripts
  • each command line parameter has a short and long name (e.g. -o and --output)
  • they don't execute when imported, just when invoked directly - see garak.analyze.report_digest for an example

The cli-accessible scripts in this package are:

  • aggregate_reports
  • analyze_log
  • count_tokens
  • get_tree
  • misp
  • perf_stats
  • qual_review
  • report_avid

-- addresses one part of #356

Metadata

Metadata

Assignees

No one assigned

    Labels

    cliCommand-line interface functionsgood first issueGood for newcomersreportingReporting, analysis, and other per-run result functions

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions