CLI Reference

Command Line Interface

The IntlPull CLI is the fastest way to manage translations in your development workflow. Sync and push translations without leaving your terminal.

Installation

$npm install -g @intlpullhq/cli

Or use npx to run without installing: npx @intlpullhq/cli <command>

Configuration

Run npx @intlpullhq/cli init to create a config file. The CLI will prompt for your project settings.

The config file (intlpull.config.js) looks like this:

module.exports = {
  projectId: 'proj_abc123',
  sourceLanguage: 'en',
  outputDir: './messages',
  format: 'json',
  namespaces: ['common', 'auth', 'settings']
}

Commands

init

Initialize IntlPull in your project. Creates config file and links to your project.

Usage:

$npx @intlpullhq/cli init

Options:

--project <id>Specify project ID
--format <type>Output format (json, yaml, ts)

sync

Download translations from IntlPull to your local project.

Usage:

$npx @intlpullhq/cli sync

Options:

--lang <code>Only sync specific language
--namespace <name>Only sync specific namespace
--watchWatch for changes and sync automatically

push

Upload local translations to IntlPull.

Usage:

$npx @intlpullhq/cli upload

Options:

--file <path>Push specific file
--overwriteOverwrite existing translations

watch

Watch for translation changes and sync in real-time.

Usage:

$npx @intlpullhq/cli watch

Options:

--poll <ms>Polling interval (default: 3000)

migrate

Import from other translation platforms.

Usage:

$npx @intlpullhq/cli migrate --from lokalise

Options:

--from <platform>Source: lokalise, crowdin, phrase, transifex
--api-key <key>API key for source platform

status

Show translation status and missing keys.

Usage:

$npx @intlpullhq/cli status

Options:

--lang <code>Check specific language

Common Workflows

Daily Development

Start watch mode to sync changes in real-time while you develop:

$npx @intlpullhq/cli watch

Find Missing Translations

Check for missing translations across all languages:

$npx @intlpullhq/cli check

CI/CD Integration

Pull translations in your build pipeline:

$npx @intlpullhq/cli sync && npm run build

Environment Variables

Variable	Description
INTLPULL_API_KEY	Your API key (recommended for CI)
INTLPULL_PROJECT_ID	Override project ID from config
INTLPULL_OUTPUT_DIR	Override output directory