indexgap brief

command

Turn findings into work orders.

Lays the findings out as markdown files in indexgap-briefs/, mirroring the page tree, with an imperative fix, the thresholds the result must meet, and the dataset row as the only permitted source of numbers. Writes no page text, deliberately.

Usage

usage: indexgap brief [-h] [--site SITE] [--home HOME] [--config CONFIG]
                      [--profile PROFILE] [--out-dir OUT_DIR] [--limit LIMIT]
                      [--dataset DATASET] [--keyword KEYWORD]
                      [--robots ROBOTS] [--no-content] [--no-aeo] [--write]
                      [--lang {en,ru}]
                      [root]

positional arguments:
  root               directory of pages; taken from indexgap.json by default

options:
  -h, --help         show this help message and exit
  --site SITE        the full site address; taken from indexgap.json by
                     default
  --home HOME        URL of the home page; defaults to --site itself
  --config CONFIG    path to indexgap.json; looked for next to the pages by
                     default
  --profile PROFILE  content type: catalog, events, ugc, product. Changes
                     thresholds and which checks run — see `indexgap profiles`
  --out-dir OUT_DIR  where to put the briefs
  --limit LIMIT      how many page briefs to write: the heaviest first. 0
                     means all of them
  --dataset DATASET  the keyword set (CSV or XLSX): its rows go into the brief
                     as the only source of numbers
  --keyword KEYWORD  the keyword column in the dataset
  --robots ROBOTS    path to the project's robots.txt
  --no-content       skip the text checks
  --no-aeo           skip the machine-readability checks
  --write            actually create the files; without it this is a dry run
  --lang {en,ru}     output language: en or ru. By default from INDEXGAP_LANG
                     or the system locale, otherwise English

The rest of the pipeline

← check · sitemap →