CLI Reference
The @palamedes/cli package publishes pmds. It is a native Rust binary; npm is only a distribution mechanism.
pmds extract
Extracts messages from configured source files and writes source-string-first catalogs.
pmds extract
pmds extract --config ./palamedes.yaml
pmds extract --clean
pmds extract --force-clean
pmds extract --watch
pmds extract --verboseOptions:
| Option | Description |
|---|---|
-c, --config <path> | Use a specific config file. |
-w, --watch | Re-run extraction on file changes. |
--clean | Remove obsolete entries with obsolete-since at least 30 days old; keep undated obsolete entries. |
--force-clean | Remove all obsolete entries immediately, including undated entries. |
-v, --verbose | Print verbose extraction details. |
pmds audit
Audits catalogs for missing translations and ICU authoring issues.
pmds audit
pmds audit --locale de fr
pmds audit --locale de,fr
pmds audit --json
pmds audit --fail-on warningOptions:
| Option | Description |
|---|---|
-c, --config <path> | Use a specific config file. |
--locale <locale...> | Audit only selected target locales. Space-separated and comma-separated values are accepted. |
--json | Print the machine-readable audit result. |
--fail-on <level> | Fail on error or warning. Default: error. |
pmds report
Reports per-locale translation completeness from configured catalogs. Source locale entries count as translated; target locales are compared against the source catalog messages that are not obsolete.
pmds report
pmds report --locale de fr
pmds report --locale de,fr --json
pmds report --fail-if-below 95Options:
| Option | Description |
|---|---|
-c, --config <path> | Use a specific config file. |
--locale <locale...> | Report only selected target locales. Space-separated and comma-separated values work. |
--json | Print the machine-readable completeness report. |
--fail-if-below <percent> | Fail when any reported locale is below this translated percentage. |
pmds catalog merge
Merges catalog files with Palamedes catalog semantics. This is suitable for Git merge-driver workflows.
pmds catalog merge ours.po theirs.po --output merged.po
pmds catalog merge %A %B --base %O --output %A --format po --conflict-strategy use-first
pmds catalog merge ours.fcl theirs.fcl --output merged.fcl --format fclpmds catalog merge requires exactly two input catalogs in precedence order.
Options:
| Option | Description |
|---|---|
--output <path> | Required output path. |
-c, --config <path> | Use a specific config file when inferring source-locale. |
--format <format> | po or fcl. Inferred from paths when omitted. |
--base <path> | Optional ancestor catalog path supplied by Git merge drivers. |
--conflict-strategy <strategy> | use-first, use-last, or error. Default: use-first. |
--source-locale <locale> | Source locale for catalog semantics. Defaults to config or en. |
--locale <locale> | Locale of the merged catalog. |
pmds catalog convert
Converts supported PO catalogs to Ferrocat Catalog Lines (FCL). Conversion
fails before writing output when a PO source contains raw fuzzy flags.
pmds catalog convert src/locales/de.po --to fcl --output src/locales/de.fcl
pmds catalog convert src/locales/de.po --to fcl --locale de
pmds catalog convert --config palamedes.yaml --to fclConfig mode writes .fcl files beside existing .po files and leaves the
source catalogs untouched. Update the catalog config afterwards:
catalogs:
- path: src/locales/{locale}
format: fcl
include: [src]See Catalog formats for when to keep PO storage and when to opt into FCL.
Options:
| Option | Description |
|---|---|
<input> | Optional input catalog for single-file conversion. |
-c, --config <path> | Convert configured PO catalogs. Cannot be combined with --output. |
--to <format> | Target format. Currently fcl. |
--output <path> | Output path for single-file conversion. Defaults to the input path with a .fcl extension. |
--source-locale <locale> | Source locale for single-file conversion. Default: en. |
--locale <locale> | Locale for single-file conversion. |
pmds version
Prints the installed CLI version.
pmds version