Skip to content

Kanjou CLI

The @kanjou/cli package provides a set of command-line tools to manage, compile, and maintain your locale files.

Installation

bash
npm install -D @kanjou/cli
bash
pnpm add -D @kanjou/cli
bash
yarn add -D @kanjou/cli
bash
bun add -d @kanjou/cli

Basic Usage

You can run the CLI using your package manager's executor:

bash
npx kanjou <command> [options]

Commands

  • kanjou compile: Compile JSON locale files into optimized .js or .json formats.
  • kanjou generate: Generate E2E type-safe .d.ts definitions from your base locale.
  • kanjou compare: Compare locale files to find missing translation keys across different languages.
  • kanjou missing: Find translation keys used in your source code but missing from your locale files.
  • kanjou unused: Find keys defined in your locale files that are not used in your code.

Released under the ISC License.