Command line tools

CLI Reference

This page provides documentation for PatchScope command line tools.

The PatchScope includes four key elements, each with the corresponding CLI (Command Line Interface) tool:

1. extracting patches from a version control system or user-provided folders
   either as separate step with diff-generate, or integrated into the annotation step (diff-annotate)
2. applying specified annotation rules for selected patches
   using diff-annotate, which generates one JSON data file per patch
3. generating configurable reports or summaries
   with various subcommands of diff-gather-stats; each summary is saved as a single JSON file
4. advanced visualization with a web application (dashboard),
   (using the summaries generated in the previous step), which you can run it with panel serve, or diffinsights-web