Skip to content

Onboarding hub

What is i18nprune?

i18nprune helps you keep translation keys and locale JSON in sync. When your code and locale files drift apart, you typically end up with missing keys, “dynamic” translation warnings, and extra review work to understand what is safe to change.

This hub helps you pick the fastest path based on how you will use i18nprune.

Pick your path

  • CLI path for day-to-day installs and workflows
  • SDK path for scripts, Workers, and custom hosts using @i18nprune/core
  • CI path for validate --json gates and stable issue codes
  • Hosted surfaces for the web report UI and shared snapshots
  • Contributors if you want to help improve i18nprune

Fastest win (try now)

Run validation and get a machine-readable result.

bash
i18nprune validate --json | jq '{ok, missing: (.data.missing | length), dynamic: .data.dynamic.count}'

If ok is true, your source usage and source locale shape are aligned.

Preview locale alignment (no disk writes)

bash
i18nprune sync --dry-run --json | jq '.data.files[] | {path, changed}'

This simulates locale-file shape alignment without changing disk.

Optional next action: apply the sync

If the preview output looks correct:

bash
i18nprune sync --yes

Keep it in CI

bash
i18nprune validate --json | jq -e '.ok'

This fails the job when validation is not OK.

Surfaces matrix

SurfaceTypical use
npm CLIInstall + run common commands
@i18nprune/coreProgrammatic SDK usage (@i18nprune/core)
report.i18nprune.devOpen and troubleshoot report payloads
git.i18nprune.devBrowse monorepo commit history, authors, tags, and weekly timeline
workers.i18nprune.devPrepare snapshots and serve shared metadata
VS Code extension (apps/extension/)Editor host — in development, planned post-v1 (same core engine as CLI)