Skip to main content

Usage

hyperlocalise status [--config <path>] [flags]

Flags

  • --config: path to config file
  • --locale: target locale filter (repeatable)
  • --output: output format (csv)
  • --group: filter by group name
  • --bucket: filter by bucket name
  • -i, --interactive: render interactive dashboard in TTY (requires --output csv)

Status values

  • translated: value is non-empty and not marked as draft
  • needs_review: provenance is origin=llm and state=draft
  • source_match: markdown/mdx segment is non-empty but identical to the source text
  • untranslated: value is empty

CSV schema

status --output csv always emits this header:
key,namespace,locale,status,origin,state
Column meaning:
  • key: translation key identifier
  • namespace: logical namespace for key grouping
  • locale: target locale
  • status: computed status classification
  • origin: value source (llm, human, or adapter-originated provenance)
  • state: workflow state (for example draft or curated-equivalent state)

CI-ready label mapping (experimental)

Use this mapping when your pipeline expects product-level labels:
CSV statusCI-ready label
translatedready
needs_reviewneeds review
source_matchneeds review
untranslatedmissing

CI gate examples

Block when any entries are missing:
hyperlocalise status --output csv > status.csv
awk -F, 'NR>1 && $4=="untranslated"{bad=1} END{exit bad}' status.csv
Block when needs review exceeds 20 rows:
hyperlocalise status --output csv > status.csv
awk -F, 'NR>1 && $4=="needs_review"{count++} END{exit(count>20)}' status.csv

Examples

hyperlocalise status --locale es-ES --output csv
hyperlocalise status --group default --output csv -i

See also