Command-line reference¶
Generated by scripts/gen_cli_docs.py from localizzy … --help; do not edit by
hand. Fire accepts --flag value, --flag=value and, for booleans,
--noflag. List flags take comma-separated values.
localizzy¶
NAME
localizzy
SYNOPSIS
localizzy GROUP | COMMAND
GROUPS
GROUP is one of the following:
source-fix
shard
editorial
project
qt
tm
COMMANDS
COMMAND is one of the following:
translate
Translate CATALOG into --target using memories, then an optional engine.
upgrade
Port APPROVED translations onto FRESH lupdate output; write NEW and RETIRED.
convert
Convert catalogs; use source_format=i18next for application JSON.
qa
Run the deterministic content checks on a catalog; exit 1 on blocking findings.
pseudo
Write a pseudo-localized copy of CATALOG to OUT (format from OUT's suffix).
review
Serve catalogs with the optional review UI and API.
inventory
Inventory all .tmx and .ts XML catalogs recursively under ROOT.
vocab
Inspect a vocabulary corpus at PATH: stats, list, validate, export or compare.
doctor
Report platform, Python, external tools and optional extras; install nothing.
init
Write a starter localizzy.toml under ROOT; an existing file is kept unless --force.
diff
Compare approved catalog OLD with fresh catalog NEW; print a Markdown report.
translate_json
Translate flat JSON file SOURCE ({key: Markdown text}) into --target at --out.
localizzy source-fix¶
NAME
localizzy source-fix
SYNOPSIS
localizzy source-fix COMMAND
COMMANDS
COMMAND is one of the following:
prepare
Create the Linguist mirror and snapshot; refuse to overwrite existing work.
apply
Apply finished English edits; --dry-run prints a diff without writing.
localizzy source-fix prepare¶
NAME
localizzy source-fix prepare - Create the Linguist mirror and snapshot; refuse to overwrite existing work.
SYNOPSIS
localizzy source-fix prepare SOURCE OUT ROOT <flags>
DESCRIPTION
Create the Linguist mirror and snapshot; refuse to overwrite existing work.
POSITIONAL ARGUMENTS
SOURCE
Type: str
OUT
Type: str
ROOT
Type: str
FLAGS
-v, --verbose=VERBOSE
Type: bool
Default: False
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy source-fix apply¶
NAME
localizzy source-fix apply - Apply finished English edits; --dry-run prints a diff without writing.
SYNOPSIS
localizzy source-fix apply MIRROR SOURCE ROOT <flags>
DESCRIPTION
--rebuild refreshes catalogs, mirror and snapshot from current sources even
without finished corrections, retiring messages Qt no longer extracts.
Uses MIRROR.json from source-fix prepare. Qt lupdate verifies current source
identities. Foreign translations survive unfinished for review; plurals and
conflicting or stale source edits are rejected before writes.
POSITIONAL ARGUMENTS
MIRROR
Type: str
SOURCE
Type: str
ROOT
Type: str
FLAGS
-d, --dry_run=DRY_RUN
Type: bool
Default: False
-v, --verbose=VERBOSE
Type: bool
Default: False
-l, --lupdate=LUPDATE
Type: str
Default: 'lupdate'
-r, --rebuild=REBUILD
Type: bool
Default: False
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy translate¶
NAME
localizzy translate - Translate CATALOG into --target using memories, then an optional engine.
SYNOPSIS
localizzy translate CATALOG TARGET <flags>
DESCRIPTION
Lists are comma-separated: --direct-memory a.tmx,b.tmx. Direct memory hits
(id > context > source) and whole-string glossary terms fill messages before
the engine; --finish-on picks which classes are written finished. A catalog
already in the target language keeps its complete translations; turn that
off with --nokeep-existing (or --keep-existing=False), which needs an engine
and an --out other than CATALOG. --out may be omitted
only for a TS catalog that keeps its language. The report JSON goes to
--report (default OUT.localizzy.json); --provenance=extra also writes
<extra-localizzy-origin> into TS messages.
POSITIONAL ARGUMENTS
CATALOG
Type: str
TARGET
Type: str
FLAGS
-o, --out=OUT
Type: Optional[str | None]
Default: None
-r, --report=REPORT
Type: Optional[str | None]
Default: None
-d, --direct_memory=DIRECT_MEMORY
Type: Optional[str | None]
Default: None
--glossary_memory=GLOSSARY_MEMORY
Type: Optional[str | None]
Default: None
--memory_lang=MEMORY_LANG
Type: Optional[str | None]
Default: None
--glossary_status=GLOSSARY_STATUS
Type: str
Default: 'approved,do-not-translate'
--finish_on=FINISH_ON
Type: str
Default: 'id,context'
--memory_only=MEMORY_ONLY
Type: bool
Default: False
--plural_count=PLURAL_COUNT
Type: Optional[int | None]
Default: None
-k, --keep_existing=KEEP_EXISTING
Type: bool
Default: True
--provenance=PROVENANCE
Type: str
Default: 'sidecar'
-e, --endpoint=ENDPOINT
Type: Optional[str | None]
Default: None
--model=MODEL
Type: Optional[str | None]
Default: None
--fallback_models=FALLBACK_MODELS
Type: Optional[str | None]
Default: None
-a, --api_key_env=API_KEY_ENV
Type: str
Default: 'OPENAI_API_KEY'
-c, --cache=CACHE
Type: Optional[str | None]
Default: None
--temperature=TEMPERATURE
Type: float
Default: 0.2
-s, --style_file=STYLE_FILE
Type: Optional[str | None]
Default: None
-b, --batch_size=BATCH_SIZE
Type: int
Default: 50
--timeout=TIMEOUT
Type: float
Default: 120
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy upgrade¶
NAME
localizzy upgrade - Port APPROVED translations onto FRESH lupdate output; write NEW and RETIRED.
SYNOPSIS
localizzy upgrade FRESH APPROVED OUT RETIRED <flags>
DESCRIPTION
Tiers: exact, memory id/context, relocated, fuzzy, memory source/term,
machine, pending. The report defaults to OUT + '.upgrade.json'.
POSITIONAL ARGUMENTS
FRESH
APPROVED
OUT
RETIRED
FLAGS
--report=REPORT
Type: Optional[]
Default: None
--target=TARGET
Type: Optional[]
Default: None
-d, --direct_memory=DIRECT_MEMORY
Type: Optional[]
Default: None
--glossary_memory=GLOSSARY_MEMORY
Type: Optional[]
Default: None
--memory_lang=MEMORY_LANG
Type: Optional[]
Default: None
--glossary_status=GLOSSARY_STATUS
Default: 'approved,do-not-translate'
--finish_on=FINISH_ON
Default: 'id,context'
--fuzzy_threshold=FUZZY_THRESHOLD
Default: 0.92
--relocated_finished=RELOCATED_FINISHED
Default: False
-n, --no_engine=NO_ENGINE
Default: False
-e, --endpoint=ENDPOINT
Type: Optional[]
Default: None
--model=MODEL
Type: Optional[]
Default: None
--fallback_models=FALLBACK_MODELS
Type: Optional[]
Default: None
-a, --api_key_env=API_KEY_ENV
Default: 'OPENAI_API_KEY'
-c, --cache=CACHE
Type: Optional[]
Default: None
--temperature=TEMPERATURE
Default: 0.2
-s, --style_file=STYLE_FILE
Type: Optional[]
Default: None
--timeout=TIMEOUT
Default: 120
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy convert¶
NAME
localizzy convert - Convert catalogs; use source_format=i18next for application JSON.
SYNOPSIS
localizzy convert SRC TARGET OUT <flags>
DESCRIPTION
Convert catalogs; use source_format=i18next for application JSON.
POSITIONAL ARGUMENTS
SRC
Type: str
TARGET
Type: str
OUT
Type: str
FLAGS
-a, --allow_loss=ALLOW_LOSS
Type: bool
Default: False
--plural_forms=PLURAL_FORMS
Type: Optional[str | None]
Default: None
--plural_order=PLURAL_ORDER
Type: Optional[list[str] | None]
Default: None
--source_format=SOURCE_FORMAT
Type: Optional[str | None]
Default: None
--source_lang=SOURCE_LANG
Type: Optional[str | None]
Default: None
-t, --target_lang=TARGET_LANG
Type: Optional[str | None]
Default: None
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy qa¶
NAME
localizzy qa - Run the deterministic content checks on a catalog; exit 1 on blocking findings.
SYNOPSIS
localizzy qa CATALOG <flags>
DESCRIPTION
--plural-forms 0,1,2 names the required native forms; ``auto`` derives them
from the target language. --layers pofilter,qe,judge adds the optional
layers (the judge needs --endpoint and --model). --format table, json or
sarif renders the findings, to --out when given; without --format the
result is one JSON object.
POSITIONAL ARGUMENTS
CATALOG
Type: str
FLAGS
--fail_on=FAIL_ON
Type: str
Default: 'major'
-p, --plural_forms=PLURAL_FORMS
Type: Optional[str | None]
Default: None
-l, --layers=LAYERS
Type: Optional[str | None]
Default: None
--format=FORMAT
Type: Optional[str | None]
Default: None
-o, --out=OUT
Type: Optional[str | None]
Default: None
-e, --endpoint=ENDPOINT
Type: Optional[str | None]
Default: None
--model=MODEL
Type: Optional[str | None]
Default: None
-a, --api_key_env=API_KEY_ENV
Type: str
Default: 'OPENAI_API_KEY'
-j, --judge_sample=JUDGE_SAMPLE
Type: float
Default: 0.1
--mqm_threshold=MQM_THRESHOLD
Type: int
Default: 80
-q, --qe_threshold=QE_THRESHOLD
Type: float
Default: 0.7
-b, --brand_terms=BRAND_TERMS
Type: Optional[str | None]
Default: None
-i, --ignore_keys=IGNORE_KEYS
Type: Optional[str | None]
Default: None
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy pseudo¶
NAME
localizzy pseudo - Write a pseudo-localized copy of CATALOG to OUT (format from OUT's suffix).
SYNOPSIS
localizzy pseudo CATALOG OUT <flags>
DESCRIPTION
--mode accent wraps and accents the text and pads it by --expansion of its
length; bracket uses plain brackets; rtl wraps the unchanged text in
right-to-left marks. Placeholders, tags and accelerators are never changed.
POSITIONAL ARGUMENTS
CATALOG
Type: str
OUT
Type: str
FLAGS
-e, --expansion=EXPANSION
Type: float
Default: 0.4
-m, --mode=MODE
Type: str
Default: 'accent'
-a, --allow_loss=ALLOW_LOSS
Type: bool
Default: False
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy review¶
NAME
localizzy review - Serve catalogs with the optional review UI and API.
SYNOPSIS
localizzy review CONFIG <flags>
DESCRIPTION
CONFIG is a review TOML, or a .ts/.json catalog that is first imported into
a resumable workspace (default CONFIG.review; --workspace overrides it and
--ui-files a.ui,b.ui adds form previews). The source catalog is never edited.
POSITIONAL ARGUMENTS
CONFIG
Type: str
FLAGS
-p, --port=PORT
Type: int
Default: 8765
-v, --verbose=VERBOSE
Type: bool
Default: False
-w, --workspace=WORKSPACE
Type: Optional[str | None]
Default: None
-u, --ui_files=UI_FILES
Type: Optional[str | None]
Default: None
-o, --open_browser=OPEN_BROWSER
Type: bool
Default: False
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy inventory¶
NAME
localizzy inventory - Inventory all .tmx and .ts XML catalogs recursively under ROOT.
SYNOPSIS
localizzy inventory ROOT OUTPUT <flags>
DESCRIPTION
Inventory all .tmx and .ts XML catalogs recursively under ROOT.
POSITIONAL ARGUMENTS
ROOT
Type: str
OUTPUT
Type: str
FLAGS
-v, --verbose=VERBOSE
Type: bool
Default: False
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy vocab¶
NAME
localizzy vocab - Inspect a vocabulary corpus at PATH: stats, list, validate, export or compare.
SYNOPSIS
localizzy vocab ACTION PATH <flags>
DESCRIPTION
``validate`` exits 1 when an entry lacks context or an ICU plural lacks
``other``. ``export`` writes canonical catalog JSON to --out; --locale
selects the target language of ``list`` and ``export``. --flat exports a flat
{key: text} JSON file, the input of ``translate_json``. ``compare`` scores
the --candidate (a catalog, or a flat {key: translation} JSON file) against
the --locale references and exits 1 when the exact-match rate is below
--min-exact.
POSITIONAL ARGUMENTS
ACTION
Type: str
PATH
Type: str
FLAGS
-l, --locale=LOCALE
Type: Optional[str | None]
Default: None
-o, --out=OUT
Type: Optional[str | None]
Default: None
--format=FORMAT
Type: str
Default: 'table'
-c, --candidate=CANDIDATE
Type: Optional[str | None]
Default: None
-m, --min_exact=MIN_EXACT
Type: Optional[float | None]
Default: None
--flat=FLAT
Type: bool
Default: False
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy doctor¶
NAME
localizzy doctor - Report platform, Python, external tools and optional extras; install nothing.
SYNOPSIS
localizzy doctor -
DESCRIPTION
Report platform, Python, external tools and optional extras; install nothing.
localizzy init¶
NAME
localizzy init - Write a starter localizzy.toml under ROOT; an existing file is kept unless --force.
SYNOPSIS
localizzy init <flags>
DESCRIPTION
Write a starter localizzy.toml under ROOT; an existing file is kept unless --force.
FLAGS
-r, --root=ROOT
Type: str
Default: '.'
-f, --force=FORCE
Type: bool
Default: False
localizzy diff¶
NAME
localizzy diff - Compare approved catalog OLD with fresh catalog NEW; print a Markdown report.
SYNOPSIS
localizzy diff OLD NEW <flags>
DESCRIPTION
Messages pair as ``localizzy upgrade`` pairs them (message id, else context,
source and comment). --report also writes the full report as JSON. Returns
the counts. A --report that is OLD or NEW is refused.
POSITIONAL ARGUMENTS
OLD
Type: str
NEW
Type: str
FLAGS
-r, --report=REPORT
Type: Optional[str | None]
Default: None
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy shard¶
NAME
localizzy shard
SYNOPSIS
localizzy shard COMMAND
COMMANDS
COMMAND is one of the following:
split
Split catalog SOURCE into --parts shards in OUT_DIR, keeping contexts whole.
merge
Fill the --target template of SOURCE from translated SHARDS into --out.
localizzy shard split¶
NAME
localizzy shard split - Split catalog SOURCE into --parts shards in OUT_DIR, keeping contexts whole.
SYNOPSIS
localizzy shard split SOURCE OUT_DIR <flags>
DESCRIPTION
OUT_DIR holding shards of SOURCE (<stem>-shard*.ts) is refused unless
--force, which first removes the earlier <stem>-shard<N>.ts files.
POSITIONAL ARGUMENTS
SOURCE
Type: str
OUT_DIR
Type: str
FLAGS
-p, --parts=PARTS
Type: int
Default: 4
-f, --force=FORCE
Type: bool
Default: False
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy shard merge¶
NAME
localizzy shard merge - Fill the --target template of SOURCE from translated SHARDS into --out.
SYNOPSIS
localizzy shard merge SOURCE SHARDS TARGET PLURAL_COUNT OUT <flags>
DESCRIPTION
SHARDS is comma-separated. An existing --out is refused unless --force; an
--out that is an input, or a shard in another language, is refused. Exits 1 when a message stays unfilled; the catalog is still written.
POSITIONAL ARGUMENTS
SOURCE
Type: str
SHARDS
Type: str
TARGET
Type: str
PLURAL_COUNT
Type: int
OUT
Type: str
FLAGS
-f, --force=FORCE
Type: bool
Default: False
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy translate_json¶
NAME
localizzy translate_json - Translate flat JSON file SOURCE ({key: Markdown text}) into --target at --out.
SYNOPSIS
localizzy translate_json SOURCE TARGET OUT <flags>
DESCRIPTION
--titles: the keys are English titles and are translated too. --product
describes what the texts document (default: a software application).
--glossary-memory a.tmx,b.tmx adds the terms each batch mentions.
--fallback-models b,c names the models to try, in order, when a request to
--model fails or its answer is rejected. A text that several keys share is
translated once. An item whose batch failed is retried alone, then
paragraph by paragraph (a <pre> block stays as it is), then with its markup
masked as numbered tokens; --norescue turns that off. Resume is
by English key; provenance goes to OUT's ``.localizzy.json`` sidecar. Exits
1, leaving --out untouched, until every item is translated; finished batches
are kept in OUT's ``.partial.json`` after each batch. Ctrl+C exits 130. An
--out (or its sidecar or partial file) that is an input is refused.
POSITIONAL ARGUMENTS
SOURCE
Type: str
TARGET
Type: str
OUT
Type: str
FLAGS
-e, --endpoint=ENDPOINT
Type: Optional[str | None]
Default: None
-m, --model=MODEL
Type: Optional[str | None]
Default: None
-a, --api_key_env=API_KEY_ENV
Type: str
Default: 'OPENAI_API_KEY'
--temperature=TEMPERATURE
Type: float
Default: 0.2
--timeout=TIMEOUT
Type: float
Default: 120
--style_file=STYLE_FILE
Type: Optional[str | None]
Default: None
--glossary_memory=GLOSSARY_MEMORY
Type: Optional[str | None]
Default: None
--glossary_status=GLOSSARY_STATUS
Type: str
Default: 'approved,do-not-translate'
--source_lang=SOURCE_LANG
Type: str
Default: 'en'
-p, --product=PRODUCT
Type: Optional[str | None]
Default: None
--titles=TITLES
Type: bool
Default: False
-b, --batch_size=BATCH_SIZE
Type: int
Default: 5
-w, --workers=WORKERS
Type: int
Default: 3
-f, --fallback_models=FALLBACK_MODELS
Type: Optional[str | None]
Default: None
-r, --rescue=RESCUE
Type: bool
Default: True
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy editorial¶
NAME
localizzy editorial
SYNOPSIS
localizzy editorial COMMAND
COMMANDS
COMMAND is one of the following:
review
Ask a model to review the --target translation in CATALOG; append proposals to OUT.
apply
Apply accepted CANDIDATES (from ``review``) to CATALOG and write LEDGER.
localizzy editorial review¶
NAME
localizzy editorial review - Ask a model to review the --target translation in CATALOG; append proposals to OUT.
SYNOPSIS
localizzy editorial review CATALOG TARGET OUT <flags>
DESCRIPTION
The catalog is never edited. CATALOG is a Qt .ts file, or a translated JSON
file with --source-json naming the English one. --product describes the
application in a phrase ("a professional font editor"); --style-file is the
language style sheet; --glossary-memory lists TMX memories, comma-separated,
whose terms are sent with each batch. --glossary-status picks the term
statuses that count (comma-separated; default approved,do-not-translate;
add proposed for a language whose glossary is not reviewed yet).
--endpoint and --model are required; the key comes from --api-key-env.
--timeout defaults to 300 seconds because a batch of 40 messages returns
long corrected texts. Re-running skips batches already in OUT unless the
items, model, prompt, style sheet or glossary terms changed. Messages with
length variants are not reviewed (``apply`` cannot write them); they are
counted under left_out. --limit reviews only the first N pending batches.
POSITIONAL ARGUMENTS
CATALOG
Type: str
TARGET
Type: str
OUT
Type: str
FLAGS
-m, --model=MODEL
Type: Optional[str | None]
Default: None
-e, --endpoint=ENDPOINT
Type: Optional[str | None]
Default: None
--style_file=STYLE_FILE
Type: Optional[str | None]
Default: None
--glossary_memory=GLOSSARY_MEMORY
Type: Optional[str | None]
Default: None
-p, --product=PRODUCT
Type: str
Default: 'a desktop application'
--source_json=SOURCE_JSON
Type: Optional[str | None]
Default: None
-a, --api_key_env=API_KEY_ENV
Type: str
Default: 'OPENAI_API_KEY'
--temperature=TEMPERATURE
Type: float
Default: 0.2
--timeout=TIMEOUT
Type: float
Default: 300
-w, --workers=WORKERS
Type: int
Default: 4
-b, --batch_size=BATCH_SIZE
Type: int
Default: 40
-l, --limit=LIMIT
Type: int
Default: 0
--glossary_status=GLOSSARY_STATUS
Type: str
Default: 'approved,do-not-translate'
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy editorial apply¶
NAME
localizzy editorial apply - Apply accepted CANDIDATES (from ``review``) to CATALOG and write LEDGER.
SYNOPSIS
localizzy editorial apply CATALOG TARGET CANDIDATES LEDGER <flags>
DESCRIPTION
A correction lands only while CATALOG still holds the English source and
translation the reviewer saw, and only if it keeps the source's
placeholders, tags, trailing ellipsis or colon, surrounding whitespace,
newlines and the translation's accelerator count. Stale and refused
candidates are listed in the ledger; corrections already in the catalog
count as already_applied. --severity and --family filter
(comma-separated); --reject-ids names a file with one id per line to leave
unchanged; --allow-markup-changes lets markup-family corrections change
tags (nothing else). Qt messages keep their state unless --finish says a
human accepted the candidates. --target is recorded as each change's
language. The catalog and LEDGER are written together or not at all; an
existing LEDGER is refused unless --force. --dry-run writes nothing.
POSITIONAL ARGUMENTS
CATALOG
Type: str
TARGET
Type: str
CANDIDATES
Type: str
LEDGER
Type: str
FLAGS
--source_json=SOURCE_JSON
Type: Optional[str | None]
Default: None
--severity=SEVERITY
Type: str
Default: 'critical,major,minor'
--family=FAMILY
Type: str
Default: 'accuracy,terminology,conventions,locale,style,compliance,ma...
-r, --reject_ids=REJECT_IDS
Type: Optional[str | None]
Default: None
--scope=SCOPE
Type: Optional[str | None]
Default: None
-d, --dry_run=DRY_RUN
Type: bool
Default: False
-a, --allow_markup_changes=ALLOW_MARKUP_CHANGES
Type: bool
Default: False
--finish=FINISH
Type: bool
Default: False
--force=FORCE
Type: bool
Default: False
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy project¶
NAME
localizzy project
SYNOPSIS
localizzy project COMMAND
COMMANDS
COMMAND is one of the following:
upgrade
Port the approved catalog of CODE onto the fresh lupdate output.
translate
Fill the catalog of CODE from its memories, then the engine.
build_ui
Rebuild the project memory of CODE from its approved catalog.
localizzy project upgrade¶
NAME
localizzy project upgrade - Port the approved catalog of CODE onto the fresh lupdate output.
SYNOPSIS
localizzy project upgrade CODE <flags>
DESCRIPTION
Writes NEW beside the approved catalog (``<name>.new.ts``), RETIRED under
``[catalogs].retired_dir`` and the report under ``report_dir``. RETIRED is
named from the sha256 of both inputs and never overwritten: a rerun on the
same inputs must produce the same retired messages, or it is refused.
--in-place replaces the approved catalog only when nothing stays pending
(pending messages exit 1 and leave NEW for review). --glossary adds memories to the
configured ones; --no-engine leaves new strings pending.
POSITIONAL ARGUMENTS
CODE
Type: str
FLAGS
--fresh=FRESH
Type: Optional[str | None]
Default: None
-o, --out=OUT
Type: Optional[str | None]
Default: None
-m, --model=MODEL
Type: Optional[str | None]
Default: None
-n, --no_engine=NO_ENGINE
Type: bool
Default: False
-i, --in_place=IN_PLACE
Type: bool
Default: False
-g, --glossary=GLOSSARY
Type: Optional[str | None]
Default: None
--fuzzy_threshold=FUZZY_THRESHOLD
Type: float
Default: 0.92
-c, --config=CONFIG
Type: Optional[str | None]
Default: None
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy project translate¶
NAME
localizzy project translate - Fill the catalog of CODE from its memories, then the engine.
SYNOPSIS
localizzy project translate CODE <flags>
DESCRIPTION
--source-catalog starts a new language from the source-language catalog.
That keeps no existing translation, so it is refused when the catalog of
CODE exists and --out was not given. --memory-only needs no endpoint.
POSITIONAL ARGUMENTS
CODE
Type: str
FLAGS
--catalog=CATALOG
Type: Optional[str | None]
Default: None
-o, --out=OUT
Type: Optional[str | None]
Default: None
--model=MODEL
Type: Optional[str | None]
Default: None
--memory_only=MEMORY_ONLY
Type: bool
Default: False
-g, --glossary=GLOSSARY
Type: Optional[str | None]
Default: None
-s, --source_catalog=SOURCE_CATALOG
Type: Optional[str | None]
Default: None
-b, --batch_size=BATCH_SIZE
Type: int
Default: 50
--config=CONFIG
Type: Optional[str | None]
Default: None
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy project build_ui¶
NAME
localizzy project build_ui - Rebuild the project memory of CODE from its approved catalog.
SYNOPSIS
localizzy project build_ui CODE <flags>
DESCRIPTION
The output is the first ``[memories].direct`` name. Exact pairs already
served by the glossary memories are left out, so a missing glossary memory
is an error: its terms would otherwise enter the project memory.
POSITIONAL ARGUMENTS
CODE
Type: str
FLAGS
-o, --out=OUT
Type: Optional[str | None]
Default: None
-c, --config=CONFIG
Type: Optional[str | None]
Default: None
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy qt¶
NAME
localizzy qt
SYNOPSIS
localizzy qt GROUP | COMMAND
GROUPS
GROUP is one of the following:
applang
COMMANDS
COMMAND is one of the following:
scan
Audit Qt/C++ sources and .ui forms for strings that will not translate.
extract
Run Qt lupdate over source directories or .pro files into PREFIX_<locale>.ts.
release
Compile .ts catalogs to .qm with Qt lrelease, beside each catalog or in --out-dir.
localizzy qt scan¶
NAME
localizzy qt scan - Audit Qt/C++ sources and .ui forms for strings that will not translate.
SYNOPSIS
localizzy qt scan <flags> [SOURCES]...
DESCRIPTION
--engine heuristic is a fast line pass; clang uses libclang (the ``clang``
extra) and reads --compile-commands when given; both runs clang on files
with critical heuristic findings. --format table, json or sarif. Exit 1 on
a critical finding, or when coverage is below --min-coverage; --min-coverage
over zero C++ files is a usage error (exit 2).
POSITIONAL ARGUMENTS
SOURCES
Type: str
FLAGS
-e, --engine=ENGINE
Type: str
Default: 'heuristic'
-u, --ui=UI
Type: bool
Default: True
-m, --min_coverage=MIN_COVERAGE
Type: Optional[float | None]
Default: None
-f, --format=FORMAT
Type: str
Default: 'table'
-o, --out=OUT
Type: Optional[str | None]
Default: None
--compile_commands=COMPILE_COMMANDS
Type: Optional[str | None]
Default: None
--config=CONFIG
Type: Optional[str | None]
Default: None
localizzy qt extract¶
NAME
localizzy qt extract - Run Qt lupdate over source directories or .pro files into PREFIX_<locale>.ts.
SYNOPSIS
localizzy qt extract <flags> [SOURCES]...
DESCRIPTION
Existing catalogs are merged and replaced only after lupdate succeeds;
strings that left the source stay as vanished with their translations.
--no-obsolete drops translations of strings that left the source.
--locales de,fr; the source-language catalog is always written.
Unset options come from localizzy.toml ([qt] and [source]).
POSITIONAL ARGUMENTS
SOURCES
Type: str
FLAGS
-o, --out_dir=OUT_DIR
Type: Optional[str | None]
Default: None
--locales=LOCALES
Type: Optional[str | None]
Default: None
-p, --prefix=PREFIX
Type: Optional[str | None]
Default: None
-s, --source_lang=SOURCE_LANG
Type: Optional[str | None]
Default: None
--locations=LOCATIONS
Type: str
Default: 'none'
-n, --no_obsolete=NO_OBSOLETE
Type: bool
Default: False
-c, --config=CONFIG
Type: Optional[str | None]
Default: None
localizzy qt release¶
NAME
localizzy qt release - Compile .ts catalogs to .qm with Qt lrelease, beside each catalog or in --out-dir.
SYNOPSIS
localizzy qt release <flags> [CATALOGS]...
DESCRIPTION
Compile .ts catalogs to .qm with Qt lrelease, beside each catalog or in --out-dir.
POSITIONAL ARGUMENTS
CATALOGS
Type: str
FLAGS
-o, --out_dir=OUT_DIR
Type: Optional[str | None]
Default: None
localizzy qt applang¶
NAME
localizzy qt applang
SYNOPSIS
localizzy qt applang COMMAND
COMMANDS
COMMAND is one of the following:
list
List the UI languages compiled into a macOS Qt app as PREFIX_<lang>.qm resources.
run
Launch a macOS Qt app in UI language LANG; --new starts a separate instance.
write_commands
Write one double-clickable <name>-<lang>.command launcher per UI language into OUT.
localizzy qt applang list¶
NAME
localizzy qt applang list - List the UI languages compiled into a macOS Qt app as PREFIX_<lang>.qm resources.
SYNOPSIS
localizzy qt applang list APP PREFIX <flags>
DESCRIPTION
List the UI languages compiled into a macOS Qt app as PREFIX_<lang>.qm resources.
POSITIONAL ARGUMENTS
APP
Type: str
PREFIX
Type: str
FLAGS
-s, --source_lang=SOURCE_LANG
Type: str
Default: 'en'
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy qt applang run¶
NAME
localizzy qt applang run - Launch a macOS Qt app in UI language LANG; --new starts a separate instance.
SYNOPSIS
localizzy qt applang run APP LANG PREFIX <flags>
DESCRIPTION
Launch a macOS Qt app in UI language LANG; --new starts a separate instance.
POSITIONAL ARGUMENTS
APP
Type: str
LANG
Type: str
PREFIX
Type: str
FLAGS
-n, --new=NEW
Type: bool
Default: False
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy qt applang write_commands¶
NAME
localizzy qt applang write_commands - Write one double-clickable <name>-<lang>.command launcher per UI language into OUT.
SYNOPSIS
localizzy qt applang write_commands APP PREFIX OUT <flags>
DESCRIPTION
Write one double-clickable <name>-<lang>.command launcher per UI language into OUT.
POSITIONAL ARGUMENTS
APP
Type: str
PREFIX
Type: str
OUT
Type: str
FLAGS
-n, --name=NAME
Type: Optional[str | None]
Default: None
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy tm¶
NAME
localizzy tm
SYNOPSIS
localizzy tm COMMAND
COMMANDS
COMMAND is one of the following:
tmx2qph
Convert a TMX file to a Qt phrase book, retaining every pair in input order.
tmx2html
Render a TMX as a self-contained HTML table with filters and click-to-copy.
build_ui
Build a project memory (every finished message) from a Qt .ts catalog.
lookup
Look up every source of TS in the ``<lang>-*.tmx`` memories of TMX_DIR.
glossary_json
Write a {source term: {code: translation}} JSON view of glossary memories to OUT.
ts2tmx
Convert one .ts file or every .ts under a folder to TMX (legacy language policy).
po2tmx
Convert one .po file or every .po under a folder to TMX (legacy language policy).
lproj2tmx
Scan a directory for Apple .lproj resources and .loctable files; write <lang>.tmx.
adobe2tmx
Convert an Adobe app folder's localization resources into per-language TMX.
oss2tmx
Fetch upstream translations of open-source apps and write <app>/<lang>.tmx.
norm
Rename every .tmx under a folder to its shortest BCP 47 tag (legacy tmxnorm).
extract
Extract selected TMX pairs from bilingual, paired or multilingual resources.
localizzy tm tmx2qph¶
NAME
localizzy tm tmx2qph - Convert a TMX file to a Qt phrase book, retaining every pair in input order.
SYNOPSIS
localizzy tm tmx2qph INPUT OUTPUT TARGET <flags>
DESCRIPTION
Convert a TMX file to a Qt phrase book, retaining every pair in input order.
POSITIONAL ARGUMENTS
INPUT
Type: str
source TMX (or .tmx.gz) file.
OUTPUT
Type: str
destination .qph file, atomically replaced after validation.
TARGET
Type: str
exact target language tag, for example de or es-419.
FLAGS
-s, --src_lang=SRC_LANG
Type: str
Default: 'en'
exact source language tag (default en).
-v, --verbose=VERBOSE
Type: bool
Default: False
log the input, language pair and output count.
Notes and x-status become definitions. Proposed and identical translations are retained; Qt does not enforce review status. Other TMX properties are not exported. Missing, duplicate, empty or inline-marked segments fail explicitly, preserving an existing output. No translations are invented.
Export replaces an existing phrase book; it does not merge manual edits. Before rebuilding a curated QPH, export to a scratch path, compare targets and definitions, and reconcile approved changes into the source TMX first.
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy tm tmx2html¶
NAME
localizzy tm tmx2html - Render a TMX as a self-contained HTML table with filters and click-to-copy.
SYNOPSIS
localizzy tm tmx2html INPUT OUTPUT <flags>
DESCRIPTION
Render a TMX as a self-contained HTML table with filters and click-to-copy.
POSITIONAL ARGUMENTS
INPUT
Type: str
source TMX (or .tmx.gz) file.
OUTPUT
Type: str
destination .html file, atomically replaced.
FLAGS
--target=TARGET
Type: Optional[str | None]
Default: None
target language tag; detected when the file has exactly one.
-s, --src_lang=SRC_LANG
Type: str
Default: 'en'
source language tag (default en).
--title=TITLE
Type: Optional[str | None]
Default: None
page heading; defaults to the input file name.
-v, --verbose=VERBOSE
Type: bool
Default: False
log the counts.
Units missing either language are skipped and counted, not invented.
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy tm build_ui¶
NAME
localizzy tm build_ui - Build a project memory (every finished message) from a Qt .ts catalog.
SYNOPSIS
localizzy tm build_ui CATALOG OUT <flags>
DESCRIPTION
--exclude-memory a.tmx,b.tmx drops exact source/target pairs served by whole
glossary terms, keeping contextual translations. --lang overrides the
memory's target tag (for example es-419 for an es_MX catalog).
POSITIONAL ARGUMENTS
CATALOG
Type: str
OUT
Type: str
FLAGS
-l, --lang=LANG
Type: Optional[str | None]
Default: None
-e, --exclude_memory=EXCLUDE_MEMORY
Type: Optional[str | None]
Default: None
-n, --note=NOTE
Type: Optional[str | None]
Default: None
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy tm lookup¶
NAME
localizzy tm lookup - Look up every source of TS in the ``<lang>-*.tmx`` memories of TMX_DIR.
SYNOPSIS
localizzy tm lookup TS TMX_DIR LANGS <flags>
DESCRIPTION
--langs de,es,fr names the memory prefixes. --qph adds a phrase book's
sources. JSON goes to --out (default TS.lookup.json) and the filterable page
to --report (default TS.lookup.html); pass an empty string to skip either.
Sources without any match are left out of both.
POSITIONAL ARGUMENTS
TS
Type: str
TMX_DIR
Type: str
LANGS
Type: str
FLAGS
-q, --qph=QPH
Type: Optional[str | None]
Default: None
-o, --out=OUT
Type: Optional[str | None]
Default: None
-r, --report=REPORT
Type: Optional[str | None]
Default: None
-v, --verbose=VERBOSE
Type: bool
Default: False
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy tm glossary_json¶
NAME
localizzy tm glossary_json - Write a {source term: {code: translation}} JSON view of glossary memories to OUT.
SYNOPSIS
localizzy tm glossary_json OUT <flags>
DESCRIPTION
Either --memory a.tmx,b.tmx (codes read from each memory, or given by --codes
in the same order), or --folder DIR with --codes de,pl and --pattern
(default {code}-core.tmx). An OUT that is one of the memories is refused.
POSITIONAL ARGUMENTS
OUT
Type: str
FLAGS
-m, --memory=MEMORY
Type: Optional[str | None]
Default: None
-f, --folder=FOLDER
Type: Optional[str | None]
Default: None
-p, --pattern=PATTERN
Type: str
Default: '{code}-core.tmx'
-c, --codes=CODES
Type: Optional[str | None]
Default: None
-s, --source_lang=SOURCE_LANG
Type: str
Default: 'en'
-g, --glossary_status=GLOSSARY_STATUS
Type: str
Default: 'approved,do-not-translate'
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy tm ts2tmx¶
NAME
localizzy tm ts2tmx - Convert one .ts file or every .ts under a folder to TMX (legacy language policy).
SYNOPSIS
localizzy tm ts2tmx INPUT <flags>
DESCRIPTION
Convert one .ts file or every .ts under a folder to TMX (legacy language policy).
POSITIONAL ARGUMENTS
INPUT
Type: str
a ``.ts`` file or a directory searched recursively.
FLAGS
-o, --output=OUTPUT
Type: Optional[str | None]
Default: None
``.tmx`` path for a file input; mirrored output folder for a directory.
-s, --src_lang=SRC_LANG
Type: Optional[str | None]
Default: None
language of ``<source>`` text (default: ``sourcelanguage``, else ``en``).
-v, --verbose=VERBOSE
Type: bool
Default: False
debug logging.
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy tm po2tmx¶
NAME
localizzy tm po2tmx - Convert one .po file or every .po under a folder to TMX (legacy language policy).
SYNOPSIS
localizzy tm po2tmx INPUT <flags>
DESCRIPTION
Convert one .po file or every .po under a folder to TMX (legacy language policy).
POSITIONAL ARGUMENTS
INPUT
Type: str
a ``.po`` file or a directory searched recursively.
FLAGS
-o, --output=OUTPUT
Type: Optional[str | None]
Default: None
``.tmx`` path for a file input; mirrored output folder for a directory.
-s, --src_lang=SRC_LANG
Type: str
Default: 'en'
language of ``msgid`` text.
-f, --fuzzy=FUZZY
Type: bool
Default: False
include entries flagged fuzzy.
-v, --verbose=VERBOSE
Type: bool
Default: False
debug logging.
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy tm lproj2tmx¶
NAME
localizzy tm lproj2tmx - Scan a directory for Apple .lproj resources and .loctable files; write <lang>.tmx.
SYNOPSIS
localizzy tm lproj2tmx <flags>
DESCRIPTION
Scan a directory for Apple .lproj resources and .loctable files; write <lang>.tmx.
FLAGS
-a, --app=APP
Type: Optional[str | None]
Default: None
legacy alias for input; positional usage remains supported.
-o, --output=OUTPUT
Type: Optional[str | None]
Default: None
folder that receives <lang>.tmx files.
-d, --dedupe=DEDUPE
Type: bool
Default: True
collapse identical (source, target) pairs within a language.
-s, --skip_identical=SKIP_IDENTICAL
Type: bool
Default: False
drop units whose target equals the English source.
--include_infoplist=INCLUDE_INFOPLIST
Type: bool
Default: False
also read InfoPlist bundle metadata tables.
-v, --verbose=VERBOSE
Type: bool
Default: False
debug logging.
--input=INPUT
Type: Optional[str | None]
Default: None
directory to scan recursively (app bundle or extracted glossary).
localizzy tm adobe2tmx¶
NAME
localizzy tm adobe2tmx - Convert an Adobe app folder's localization resources into per-language TMX.
SYNOPSIS
localizzy tm adobe2tmx INPUT OUTPUT <flags>
DESCRIPTION
Convert an Adobe app folder's localization resources into per-language TMX.
POSITIONAL ARGUMENTS
INPUT
Type: str
app folder.
OUTPUT
Type: str
folder that receives <lang>.tmx files.
FLAGS
-u, --ui_lang=UI_LANG
Type: Optional[str | None]
Default: None
language of ZStrings inside binaries; auto-detected when omitted.
-d, --dedupe=DEDUPE
Type: bool
Default: True
collapse identical (source, target) pairs within a language.
-s, --skip_identical=SKIP_IDENTICAL
Type: bool
Default: False
drop units whose target equals the English source.
-i, --include_infoplist=INCLUDE_INFOPLIST
Type: bool
Default: False
also read InfoPlist.strings bundle metadata.
-v, --verbose=VERBOSE
Type: bool
Default: False
debug logging.
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy tm oss2tmx¶
NAME
localizzy tm oss2tmx - Fetch upstream translations of open-source apps and write <app>/<lang>.tmx.
SYNOPSIS
localizzy tm oss2tmx OUTPUT <flags>
DESCRIPTION
Fetch upstream translations of open-source apps and write <app>/<lang>.tmx.
POSITIONAL ARGUMENTS
OUTPUT
Type: str
folder receiving <app>/<lang>.tmx.
FLAGS
-a, --apps=APPS
Type: Optional[str | tupl...
Default: None
comma-separated subset of app names; default all.
--registry=REGISTRY
Type: Optional[str | None]
Default: None
TOML app registry replacing the packaged oss_apps.toml.
-c, --cache=CACHE
Type: Optional[str | None]
Default: None
where git checkouts live (default: <output>/_src).
--refresh=REFRESH
Type: bool
Default: False
re-clone repositories even if cached.
-v, --verbose=VERBOSE
Type: bool
Default: False
debug logging.
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy tm norm¶
NAME
localizzy tm norm - Rename every .tmx under a folder to its shortest BCP 47 tag (legacy tmxnorm).
SYNOPSIS
localizzy tm norm INPUT <flags>
DESCRIPTION
Rename every .tmx under a folder to its shortest BCP 47 tag (legacy tmxnorm).
POSITIONAL ARGUMENTS
INPUT
Type: str
folder searched recursively.
FLAGS
-d, --dry_run=DRY_RUN
Type: bool
Default: False
report only, rename nothing.
-v, --verbose=VERBOSE
Type: bool
Default: False
debug logging.
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
localizzy tm extract¶
NAME
localizzy tm extract - Extract selected TMX pairs from bilingual, paired or multilingual resources.
SYNOPSIS
localizzy tm extract INPUT OUTPUT <flags>
DESCRIPTION
TS/PO uses legacy eligible first/last plural projections. Languages come from
metadata or explicit arguments, never guessed filenames. Source and target
resource files join by key; loctables select two internal tables. Return every
unmatched target key. Invalid text/XML preserves the existing output.
POSITIONAL ARGUMENTS
INPUT
Type: str
OUTPUT
Type: str
FLAGS
--source=SOURCE
Type: Optional[str | None]
Default: None
--source_lang=SOURCE_LANG
Type: Optional[str | None]
Default: None
--target_lang=TARGET_LANG
Type: Optional[str | None]
Default: None
--source_format=SOURCE_FORMAT
Type: Optional[str | None]
Default: None
-f, --fuzzy=FUZZY
Type: bool
Default: False
-d, --dedupe=DEDUPE
Type: bool
Default: True
-v, --verbose=VERBOSE
Type: bool
Default: False
--source_key=SOURCE_KEY
Type: Optional[str | None]
Default: None
--target_key=TARGET_KEY
Type: Optional[str | None]
Default: None
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS