Skip to content

keryx voice lexicon add

Description

Add or update one pronunciation rule in pronunciation.yaml, creating the file if it does not exist. Offline — no provider call; run sync afterwards to push the change (spec 0022 R-GEN-35).

Usage

keryx voice lexicon add <word> --ipa "<phoneme>"
keryx voice lexicon add <word> --alias "<spelling>"

keryx voice lexicon add keryx --ipa "ˈkɛrɪks"
keryx voice lexicon add ffmpeg --alias "eff em peg"

Behaviour

  • Exactly one of --ipa / --alias must be given — an alias respelling works on any model; an IPA phoneme applies on a phoneme-capable model.
  • Re-adding an existing word replaces its rule in place (upsert) and reports updated rather than added.
  • Rejects an empty word, and a rule that sets both or neither of --ipa / --alias.

Flags

Flag Description Default Required
--file pronunciation rules file pronunciation.yaml
--ipa IPA phoneme string for the word (mutually exclusive with --alias)
--alias plain-spelling alias for the word (mutually exclusive with --ipa)