Branchlate CLI

Manage and sync your translations with Branchlate from the command line.

CLI reference & guides →

Installation

Run commands with npx to use the latest version:

npx branchlate@latest <command>

Quick start

1. Log in (or set BRANCHLATE_TOKEN for CI):

   npx branchlate@latest login

2. Initialize your project (creates branchlate.json):

   npx branchlate@latest init

3. Sync local translation files with Branchlate (uses your current Git branch by default):

   npx branchlate@latest sync

Main commands

| Command | Description | | --------- | ----------- | | init | Create or overwrite branchlate.json with project and file pattern settings. | | login | Authenticate and store credentials locally. | | sync | Sync local language files with Branchlate; supports --branch-name, --flatten, --auto-translate. | | format | Format language files (sort keys, consistent indentation). Use --dry-run to preview. | | status | Print translation coverage per language; useful in CI to enforce a minimum (e.g. --min-coverage=100). | | generate-token | Output a token for CI/CD (set as BRANCHLATE_TOKEN). |

For subcommands like project delete and branch delete, options, and examples, see the full reference.

Documentation

CLI reference & guides →

Installation, all commands, options, CI/CD usage, and best practices are documented there.