indexgap plan

command

Audit the dataset before a single page is generated.

Reads the keyword file, finds duplicates and near-synonyms that would become competing pages, checks that the path pattern resolves for every row, and writes the work list. The cheapest place to fix a pipeline is before it runs.

Usage

usage: indexgap plan [-h] [--keyword KEYWORD] [--out-dir OUT_DIR]
                     [--pattern PATTERN] [--min-words MIN_WORDS]
                     [--min-filled MIN_FILLED] [--brief BRIEF] [--json JSON]
                     [--write] [--lang {en,ru}]
                     dataset

positional arguments:
  dataset               keyword CSV

options:
  -h, --help            show this help message and exit
  --keyword KEYWORD     the keyword column
  --out-dir OUT_DIR     where to put the stubs
  --pattern PATTERN     path template
  --min-words MIN_WORDS
  --min-filled MIN_FILLED
                        the share of filled columns below which a row is
                        rejected (default 0 — reject nothing)
  --brief BRIEF         a file with your own brief template instead of the
                        default
  --json JSON           where to write the full breakdown
  --write               actually create the files
  --lang {en,ru}        output language: en or ru. By default from
                        INDEXGAP_LANG or the system locale, otherwise English

The rest of the pipeline

← init · check →