Command-line interface reference

Written by Elena David, SEO, ORM, and AI Visibility Consultant.

Command syntax

reputation-monitor [--previous PATH] [--current PATH]
                   [--output-dir PATH] [--maximum-rating 1-5]

Editable installation registers reputation-monitor as a console script that calls reputation_monitor.cli:main. The equivalent module invocation is:

python -m reputation_monitor.cli

Options

Paths are interpreted relative to the current working directory unless an absolute path is supplied.

Examples

Run with every default:

reputation-monitor

Use explicit snapshots:

reputation-monitor \
  --previous data/reviews_previous.csv \
  --current data/reviews_current.csv

Write into a separate run directory:

reputation-monitor --output-dir reports/october-review

Select only new 1-star reviews:

reputation-monitor --maximum-rating 1

The selected value controls filtering and generated labels. At the default of 2, new 1-star and 2-star reviews trigger alerts. With a value of 1, the CSV reason is New review rated 1 star and the HTML heading is New 1-star review alerts. With a value of 3, the labels describe ratings of 1, 2, or 3 stars.

Standard output

For a completed run, the command prints:

• valid record counts for both snapshots;
• the combined malformed-row count;
• the new-review count;
• the new low-rating alert count;
• both generated file paths.

Standard error

Row-level validation warnings and run-stopping errors are written to standard error. A run may complete with exit status 0 while also producing malformed-row warnings, because invalid rows are skipped and valid rows continue.

Exit behavior

Unexpected exceptions are not converted into a documented application-specific exit status.

Related documentation

Use Preparing reputation data for input rules, Error handling and validation for failure behavior, and Troubleshooting for corrective procedures.